listPayouts

get

https://sellingpartnerapi-na.amazon.com/finances/transfers/2024-06-01/payouts

Returns a list of payouts for the selling partner's account. Results can be filtered by marketplaceIds, accountType, date range (createdAfter and createdBefore), or a specific payoutId. By default, the API returns payouts for all available marketplaces and account types. Results are sorted in descending order of their creation dates.

Usage Plan:

Rate (requests per second)	Burst
0.5	30

The x-amzn-RateLimit-Limit response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits.

Query Params

marketplaceIds

array of strings

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.

marketplaceIds

createdAfter

date-time

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

date-time

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.

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.

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.

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.

Responses

Language

Loading…

Response

Choose an example:

application/json

200Success.

400Request has missing or invalid parameters and cannot be parsed.

403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.

404The resource specified does not exist.

413The request size exceeded the maximum accepted size.

415The request payload is in an unsupported format.

429The frequency of requests was greater than allowed.

500An unexpected condition occurred that prevented the server from fulfilling the request.

503Temporary overloading or maintenance of the server.