Skip to navigation
Network APIPayouts

List payouts

Early Access

Payouts is an early access feature. We’re actively improving this API based on your feedback.

Early access features come with some caveats:

  • May evolve rapidly, requiring integration updates
  • Not subject to our 10 year version support policy
  • Not subject to SLAs (unless specified in a contract)

Returns a list of payouts matching the given query parameters.

This endpoint is rate limited to 100 QPS.

Scopes: PAYOUTS_READ

Headers

AcceptstringRequired
X-RegionstringRequired
X-SignaturestringRequired
User-AgentstringRequired

Query parameters

cursorstringOptional>=1 character
A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query.
merchant_idstringOptional1-128 characters
Filters results to include only payouts made to a merchant that matches the given ID.
customer_idstringOptional1-128 characters
Filters results to include only payouts made to a customer that matches the given ID.
limitintegerOptional1-100Defaults to 50
Maximum number of payouts to return.

Response

OK
payoutslist of objects
List of payouts matching the given query parameters.
cursorstringOptional
The pagination cursor to be used in a subsequent request. If empty, this is the final response.

Errors

400
List Payouts Request Bad Request Error