PayFanout API reference
    Preparing search index...

    Interface PaysafePaymentLike

    interface PaysafePaymentLike {
        amount?: number;
        availableToSettle?: number;
        bacs?: PaysafeBankAccountLike;
        captureSettlement?: PaysafeSettlementLike;
        card?: PaysafeCardLike;
        currencyCode?: string;
        error?: { code?: string; message?: string };
        id: string;
        merchantRefNum?: string;
        paymentHandleToken?: string;
        paymentType?: string;
        sepa?: PaysafeBankAccountLike;
        settlements?: PaysafeSettlementLike[];
        settleWithAuth?: boolean;
        status?: string;
        txnTime?: string;
    }
    Index
    amount?: number
    availableToSettle?: number

    Remaining authorized funds not yet settled (manual-capture flow).

    captureSettlement?: PaysafeSettlementLike

    Not a Paysafe field: capturePayment's answer sets it on raw, beside the payment's own fields, to the settlement the capture made, or the one it read back or met. A partial capture's settlement is found by no read, so keep its id to refund it in the Paysafe portal.

    currencyCode?: string
    error?: { code?: string; message?: string }
    id: string
    merchantRefNum?: string
    paymentHandleToken?: string

    The handle the payment spent: how a replay tells its own payment from earlier attempts under the key.

    paymentType?: string
    settlements?: PaysafeSettlementLike[]

    The spec lists settlements on the GET /payments/{id} answer, but its example carries none and neither did the sandbox answers read so far, so reads look them up by merchantRefNum whenever the payment carries none.

    settleWithAuth?: boolean
    status?: string
    txnTime?: string