List Beneficiaries
List the organisation's saved beneficiaries, most recently paid first. Filter by currency, network, status or a free-text search.
X-Api-Key<token>API key in format: sti_env_prefix_secret
currency?stringOnly beneficiaries paid in this currency
3 <= length <= 3network?stringOnly beneficiaries paid by this network
"bank""swift"status?stringDefaults to active
"active""active""archived""all"search?stringCase-insensitive match on label, account holder or bank name
1 <= length <= 120page_size?integer1 <= value <= 10050page_token?stringDefault Response
application/json- response
beneficiaries*array<>page*curl -X GET 'https://api.sandbox.stables.money/api/v1/beneficiaries'{ "beneficiaries": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "label": "string", "status": "active", "network": "swift", "destination": { "type": "bank", "recipient_type": "individual", "date_of_birth": "string", "phone": "string", "account_holder_name": "string", "account_number": "string", "iban": "string", "bank_name": "string", "bank_country": "st", "currency": "str", "account_type": "savings", "branch_name": "string", "address": { "street": "string", "city": "string", "state": "string", "postal_code": "string", "country": "string" }, "swift_code": "string", "bic_code": "string", "ifsc_code": "string", "aba_code": "string", "sort_code": "string", "branch_code": "string", "bsb_code": "string", "bank_code": "string", "cnaps": "string", "name_in_local_language": "string", "national_identification_number": "string" }, "validation": { "valid": true, "errors": [ { "field": "string", "message": "string", "code": "UNSUPPORTED_CURRENCY" } ] }, "last_used_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "archived_at": "2019-08-24T14:15:22Z" } ], "page": { "next_page_token": "string", "total": -9007199254740991 }}Returns your organisation's saved beneficiaries, most recently paid first. Beneficiaries that have never been paid follow, newest first.
Filter by currency, network or status, or use search to match the label, account holder name or bank name. status defaults to active; pass archived or all to include archived beneficiaries.
Results are paged with page_size and page_token. See Pagination.
Related: Beneficiaries in the Developer Platform guide explains how beneficiaries are created, matched and paid.