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

    Interface FinancesTransfersApiListPayoutsRequest

    Request parameters for listPayouts operation in FinancesTransfersApi.

    interface FinancesTransfersApiListPayoutsRequest {
        accountType?: string;
        createdAfter?: string;
        createdBefore?: string;
        marketplaceIds?: string[];
        nextToken?: string;
        payoutId?: string;
    }
    Index
    accountType? createdAfter? createdBefore? marketplaceIds? nextToken? payoutId?
    accountType?: string

    The response only includes payouts associated with the specified account type.

    createdAfter?: string

    The response only includes payouts created on or after this date-time. The value must be formatted in ISO 8601 date-time format. If omitted, no start date filter is applied.

    createdBefore?: string

    The response only includes payouts created before this date-time. The value must be formatted in ISO 8601 date-time format. If omitted, no end date filter is applied.

    marketplaceIds?: string[]

    The Amazon stores from which to retrieve payouts. The Amazon store ID is a globally unique identifier assigned to each Amazon store. If omitted, the response includes payouts from all applicable stores. To find the Amazon store ID for your region, refer to Store Identifiers.

    nextToken?: string

    The response includes `nextToken` when the number of results exceeds the page size. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.

    payoutId?: string

    The response only includes the payout matching the specified identifier.

    Settings
    Member Visibility

    On This Page
    Properties