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

    An optional query parameter to filter payouts by a specific account type. When provided, only payouts associated with the specified account type will be returned.

    createdAfter?: string

    An optional query parameter to filter payouts created on or after this date-time. When provided, the response will only include payouts with a creation date on or after the specified date-time. The value must be formatted in ISO 8601 date-time format. If omitted, no start date filter is applied.

    createdBefore?: string

    An optional query parameter to filter payouts created before this date-time. When provided, the response will only include payouts with a creation date before the specified date-time (exclusive). The value must be formatted in ISO 8601 date-time format. If omitted, no end date filter is applied.

    marketplaceIds?: string[]

    An optional query parameter that specifies the marketplaces from which to retrieve payouts. The marketplace ID is a globally unique identifier assigned to each Amazon marketplace. When provided, the response will only include payouts associated with the specified marketplaces. If omitted, payouts from all applicable marketplaces may be returned. To find the marketplace ID for your region, refer to Marketplace IDs.

    nextToken?: string

    The response includes `nextToken` when the number of results exceeds the specified 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

    An optional query parameter that specifies the payout to retrieve. When provided, the response will only include the payout matching the specified identifier.

    Settings
    Member Visibility

    On This Page
    Properties