Skip to main content
GET
List Payout Destinations

Path Parameters

string
required
The account’s external ID (starts with acct_)
string
required
The beneficiary’s external ID (starts with bene_)

Query Parameters

array
Filter by status (e.g., active, disabled, inactive)
string
Filter destinations created on or after this date (ISO 8601 format)
string
Filter destinations created before this date (ISO 8601 format)
integer
default:"1"
Page number (minimum 1)
integer
default:"10"
Items per page (1-100)

Response

array
Array of payout destination objects
integer
Current page number
integer
Items per page
integer
Total number of items
integer
Total number of pages

Response Example