@sumup/sdk
    Preparing search index...

    Type Alias FinancialPayout

    Financial Payout

    A single payout-related record.

    A record can represent either:

    • an actual payout sent to the merchant (type = PAYOUT)
    • a deduction applied against merchant funds for a refund, chargeback, direct debit return, or balance adjustment
    type FinancialPayout = {
        amount: number;
        currency: string;
        date: string;
        fee: number;
        id: number;
        reference: string;
        status: "SUCCESSFUL" | "FAILED";
        transaction_code: string;
        type:
            | "PAYOUT"
            | "CHARGE_BACK_DEDUCTION"
            | "REFUND_DEDUCTION"
            | "DD_RETURN_DEDUCTION"
            | "BALANCE_DEDUCTION";
    }
    Index

    Properties

    amount currency date fee id reference status transaction_code type

    Properties

    amount: number

    Amount of the payout or deduction in major units.

    currency: string

    Three-letter ISO 4217 currency code of the payout.

    date: string

    Payout date associated with the record, in YYYY-MM-DD format.

    fee: number

    Fee amount associated with the payout record, in major units.

    id: number

    Unique identifier of the payout-related record.

    reference: string

    Processor or payout reference associated with the record.

    status: "SUCCESSFUL" | "FAILED"

    Merchant-facing outcome of the payout record.

    transaction_code: string

    Transaction code of the original sale associated with the payout or deduction.

    type:
        | "PAYOUT"
        | "CHARGE_BACK_DEDUCTION"
        | "REFUND_DEDUCTION"
        | "DD_RETURN_DEDUCTION"
        | "BALANCE_DEDUCTION"

    High-level payout record category.

    Settings

    Member Visibility

    On This Page

    Properties