PayFanout API reference
    Preparing search index...

    Interface PaymentInfo

    interface PaymentInfo {
        amount: number;
        amountCapturable?: number;
        amountCaptured?: number;
        amountRefunded: number;
        capturedAt?: string;
        createdAt: string;
        currency: string;
        id: string;
        mandateReference?: string;
        metadata?: Record<string, string>;
        paymentMethodDetails?: PaymentMethodDetails;
        paymentMethodType:
            | "card"
            | "apple_pay"
            | "google_pay"
            | "paypal"
            | "ideal"
            | "sepa_debit"
            | "ach"
            | "bacs_debit"
            | "pad"
            | "interac_etransfer"
            | "skrill"
            | "neteller"
            | "paysafecard"
            | "paysafecash"
            | "bank_redirect_generic"
            | "voucher_generic"
            | "other";
        pspName: string;
        pspPaymentId: string;
        raw: unknown;
        savedPaymentMethodToken?: string;
        status: | "requires_payment_method"
        | "requires_confirmation"
        | "requires_action"
        | "requires_capture"
        | "processing"
        | "succeeded"
        | "canceled"
        | "failed";
    }
    Index
    amount amountCapturable? amountCaptured? amountRefunded capturedAt? createdAt currency id mandateReference? metadata? paymentMethodDetails? paymentMethodType pspName pspPaymentId raw savedPaymentMethodToken? status
    amount: number
    amountCapturable?: number

    Authorized-but-uncaptured remainder, when the PSP reports it.

    amountCaptured?: number

    Total captured so far, when the PSP reports it — the running sum under partial/multi-capture. Absent on PSPs that don't report it.

    amountRefunded: number

    Source of truth for refund state — see getRefundState().

    capturedAt?: string

    ISO 8601, when known.

    createdAt: string

    ISO 8601.

    currency: string
    id: string
    mandateReference?: string

    Debit-rail mandate reference (SEPA/BACS/ACH), when the PSP reports one — merchants must be able to quote it in customer communication.

    metadata?: Record<string, string>

    The host metadata stored on the PSP object, echoed back where the PSP supports it (adapters that carry metadata only in signed session tokens cannot echo it on retrieve).

    paymentMethodDetails?: PaymentMethodDetails

    Present once the PSP reports instrument facts (post-confirmation).

    paymentMethodType:
        | "card"
        | "apple_pay"
        | "google_pay"
        | "paypal"
        | "ideal"
        | "sepa_debit"
        | "ach"
        | "bacs_debit"
        | "pad"
        | "interac_etransfer"
        | "skrill"
        | "neteller"
        | "paysafecard"
        | "paysafecash"
        | "bank_redirect_generic"
        | "voucher_generic"
        | "other"
    pspName: string
    pspPaymentId: string
    raw: unknown
    savedPaymentMethodToken?: string

    Present when this payment ALSO vaulted the instrument (session created with customer + savePaymentMethod: true): the SavedPaymentMethod.token to store for future off-session charges.

    status:
        | "requires_payment_method"
        | "requires_confirmation"
        | "requires_action"
        | "requires_capture"
        | "processing"
        | "succeeded"
        | "canceled"
        | "failed"

    Settings
    Member Visibility

    On This Page
    Properties