List Destination Accounts
GET
/destination-accountsThis endpoint allows API users to retrieve a list of Destination Account owned by a specified individual or company.
Query Parameters
pageinteger
Specify the page number
per_pageinteger
Specify the number of items per page
currencystring
country_codestring
owner_idstring
external_idstring
Response
OK
idstring<uuid>
type"bank_account" | "digital_wallet" | "cash_pickup" | "card"
Type of destination account
owner_idstring<uuid>
external_idstring
Your own platform’s identifier for this payment destination account.
receiving_institution_idstring<uuid>
Identifier of a receiving institution which refers to a bank or a digital wallet operator.
currencystring<iso-4217>
Local currency for this account.
country_codestring<iso-3166-1-alpha3>
The country associated with the payment destination.
aliasstring
Name or label for this payment destination.
archivedboolean
No past payment destinations can be deleted, however they can be disabled so they can be avoided for use.
accountobject
intermediary_bank_detailsobject
created_atstring<date-time>
updated_atstring<date-time>
API Reference › Local Currency Payouts API › destination-accounts