PayFanout API reference
    Preparing search index...

    Interface PaymentSession

    interface PaymentSession {
        amount: number;
        clientSecret?: string;
        currency: string;
        id: string;
        metadata?: Record<string, string>;
        pspName: string;
        pspSessionId: string;
        status:
            | "requires_payment_method"
            | "requires_confirmation"
            | "requires_action"
            | "requires_capture"
            | "processing"
            | "succeeded"
            | "canceled"
            | "failed";
    }
    Index
    amount clientSecret? currency id metadata? pspName pspSessionId status
    amount: number
    clientSecret?: string

    Token the client SDK needs to mount/confirm.

    currency: string

    Uppercase ISO 4217; NO_CURRENCY when the PSP states none.

    id: string

    Caller-supplied or generated internal id — PayFanout does NOT persist it.

    metadata?: Record<string, string>
    pspName: string
    pspSessionId: string

    e.g. Stripe PaymentIntent id / Paysafe payment-handle session context.

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

    Settings
    Member Visibility

    On This Page
    Properties