Skip to main content
GET
https://apis.hopnow.io
/
v1
/
accounts
/
{account_id}
/
beneficiaries
/
{beneficiary_id}
/
payout-destinations
List Payout Destinations
curl --request GET \
  --url https://apis.hopnow.io/v1/accounts/{account_id}/beneficiaries/{beneficiary_id}/payout-destinations \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": "<string>",
      "object": "<string>",
      "country": "<string>",
      "payout_method": "<string>",
      "type": "<string>",
      "currency": "<string>",
      "status": "<string>",
      "is_default": true,
      "created": "<string>"
    }
  ],
  "page": 123,
  "size": 123,
  "total": 123,
  "pages": 123
}

​
Path Parameters

​
account_id
string
required
The account’s external ID (starts with acc_)
​
beneficiary_id
string
required
The beneficiary’s external ID (starts with ben_)

​
Query Parameters

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

​
Response

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

​
Response Example

{
  "items": [
    {
      "id": "dest_1234567890abcdef",
      "object": "payout_destination",
      "country": "US",
      "payout_method": "ach",
      "type": "bank_account",
      "label": null,
      "currency": "USD",
      "network": null,
      "status": "active",
      "account_number_last4": "7890",
      "is_default": true,
      "created": "2024-01-15T10:00:00Z"
    }
  ],
  "page": 1,
  "size": 10,
  "total": 1,
  "pages": 1
}