@mollie/api-client/dist/types/data/methods/data.d.ts

Official Mollie API client for Node

import type Nullable from '../../types/Nullable';
import { type Amount, type FeeRegion, type Links, type PaymentMethod as PaymentMethodEnum } from '../global';
import type Model from '../Model';
export interface MethodData extends Model<'method', PaymentMethodEnum> {
    /**
     * The full name of the payment method, translated in the optional locale passed.
     *
     * @see https://docs.mollie.com/reference/v2/methods-api/get-method?path=description#response
     */
    description: string;
    /**
     * The minimum payment amount required to use this payment method.
     *
     * @see https://docs.mollie.com/reference/v2/methods-api/get-method?path=minimumAmount#response
     */
    minimumAmount: Amount;
    /**
     * The maximum payment amount allowed when using this payment method.
     *
     * @see https://docs.mollie.com/reference/v2/methods-api/get-method?path=maximumAmount#response
     */
    maximumAmount: Nullable<Amount>;
    /**
     * The URLs of images representing the payment method.
     *
     * @see https://docs.mollie.com/reference/v2/methods-api/get-method?path=image#response
     */
    image: Image;
    /**
     * Array of objects describing the pricing configuration applicable for this payment method on your account.
     *
     * @see https://docs.mollie.com/reference/v2/methods-api/get-method?path=pricing#response
     */
    pricing?: MethodPricing[];
    /**
     * Array of objects for each 'issuer' that is available for this payment method. Only relevant for iDEAL, KBC/CBC,
     * gift cards, and vouchers.
     *
     * @see https://docs.mollie.com/reference/v2/methods-api/get-method?path=pricing#response
     */
    issuers?: MethodIssuers[];
    /**
     * An object with several URL objects relevant to the payment method. Every URL object will contain an `href` and a `type` field.
     *
     * @see https://docs.mollie.com/reference/v2/methods-api/get-method?path=_links#response
     */
    _links: Links;
    /**
     * The status of the payment method.
     *
     * @see https://docs.mollie.com/reference/v2/methods-api/get-method?path=status#response
     */
    status: MethodStatus | null;
}
export interface Image {
    /**
     * The URL for a payment method icon of 32x24 pixels.
     *
     * @see https://docs.mollie.com/reference/v2/methods-api/get-method?path=image/size1x#response
     */
    size1x: string;
    /**
     * The URL for a payment method icon of 64x48 pixels.
     *
     * @see https://docs.mollie.com/reference/v2/methods-api/get-method?path=image/size2x#response
     */
    size2x: string;
    /**
     * The URL for a payment method icon in vector format. Usage of this format is preferred since it can scale to any desired size.
     *
     * @see https://docs.mollie.com/reference/v2/methods-api/get-method?path=image/svg#response
     */
    svg: string;
}
export declare enum MethodStatus {
    activated = "activated",
    pendingBoarding = "pending-boarding",
    pendingReview = "pending-review",
    pendingExternal = "pending-external",
    rejected = "rejected"
}
export declare enum MethodImageSize {
    size1x = "size1x",
    size2x = "size2x",
    svg = "svg"
}
export declare enum MethodInclude {
    issuers = "issuers",
    pricing = "pricing"
}
export interface MethodPricing {
    description: string;
    fixed: Amount;
    variable: string;
    feeRegion: FeeRegion;
}
export interface MethodIssuers {
    resource: string;
    id: string;
    name: string;
    image: Image;
}