Amazon Selling Partner API (SP-API) SDK for TypeScript
    Preparing search index...

    Interface Payout

    All the information related to a payout.

    interface Payout {
        accountTail?: string;
        amount?: Currency;
        creationDate?: string;
        currentStatus: PayoutStatusName;
        id: string;
        partnerMetadata: PartnerMetadata;
        paymentMethod?: PaymentMethodName;
        paymentRail?: string;
        period?: Period;
        relatedIdentifiers?: RelatedIdentifier[];
        statusHistory: PayoutStatusEntry[];
        traceId?: string;
        type?: PayoutTypeName;
    }
    Index
    accountTail? amount? creationDate? currentStatus id partnerMetadata paymentMethod? paymentRail? period? relatedIdentifiers? statusHistory traceId? type?
    accountTail?: string

    The last few digits of the payment instrument. May be omitted when the configured payment instrument is invalid.

    amount?: Currency
    creationDate?: string

    A date in ISO 8601 date-time format.

    currentStatus: PayoutStatusName
    id: string

    The unique identifier of the payout.

    partnerMetadata: PartnerMetadata
    paymentMethod?: PaymentMethodName
    paymentRail?: string

    The underlying payment network or clearing system used to transmit the payout.

    period?: Period
    relatedIdentifiers?: RelatedIdentifier[]

    Related business identifiers of the payout.

    statusHistory: PayoutStatusEntry[]

    A chronological list of payout status updates.

    traceId?: string

    The banking network's unique identifier for a fund transfer request.

    type?: PayoutTypeName

    Settings
    Member Visibility

    On This Page
    Properties