Skip to main content
GET
List Payout Destinations

Authorizations

Authorization
string
header
required

Bearer token authentication. Pass your API key as Authorization: Bearer sk_.... See Authentication for keys, scopes, and sandbox vs production.

Query Parameters

currency
string

Filter by destination currency code.

status
enum<string>

Filter by admin review status: pending_review, approved, or rejected.

Available options:
pending_review,
approved,
rejected
limit
integer
default:20

Number of records to return.

Required range: 1 <= x <= 100
offset
integer
default:0

Number of records to skip.

Required range: x >= 0

Response

Success - Payout destinations list retrieved

Paginated list of configured payout destinations. total counts every matching destination, not just the ones on this page.

destinations
object[]
required

Array of payout destination objects.

total
integer
required

Total number of destinations matching the query, across all pages.

Example:

1

limit
integer
required

The limit used for this page of results.

Example:

20

offset
integer
required

The offset used for this page of results.

Example:

0