Skip to main content
GET
List Payout Destinations
Lists a beneficiary’s payout destinations, newest first by creation time. disabled and pending destinations are included; deleted ones are not. Each item is the full destination object. An unknown beneficiary_id, or one belonging to another account, returns 200 with an empty page, not 404. The single-destination endpoints return 404 in the same situation. Requires an API key with read access on the payments scope.

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. Repeat the key to pass several values, for example ?statuses=active&statuses=pending. Allowed values: active, pending, disabled.
string
Only destinations created on or after this ISO 8601 timestamp (inclusive)
string
Only destinations created before this ISO 8601 timestamp (exclusive)
integer
default:"1"
Page number (minimum 1)
integer
default:"10"
Items per page (1-100)

Response

array
Payout destination objects, newest first
integer
Current page number
integer
Items per page
integer
Total number of items
integer
Total number of pages

Request Example

Response Example