Platform OverviewIntegration HubConfiguration and Customisation
API Reference

Get beneficiaries

get
https://api.sandbox.toq.io/wallet/api/customers//clients//beneficiaries

Returns the list of beneficiaries registered for a client. All filter query parameters (accountId, sourceCurrency, visible) are optional: omit them to retrieve every beneficiary the client can pay; pass them to narrow the result to a specific source account or currency. By default only visible (non-hidden) beneficiaries are returned — pass visible=ALL or visible=FALSE to include or restrict to hidden ones.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

customerId

string
required

clientId

Query Params
string

Optional. Filter beneficiaries reachable from this source account ID.

string

Optional. Filter beneficiaries reachable when sending from this currency (ISO 4217 code).

string

Filter the list of beneficiaries based on their visibility status. If set to TRUE, only visible beneficiaries are returned. If set to FALSE, only hidden beneficiaries are returned. If set to ALL, all beneficiaries, both visible and hidden, are returned. If the parameter is left empty, only visible beneficiaries are returned by default.

Responses

401

Unauthorized

403

Forbidden

404

Not Found

Updated about 12 hours ago

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
*/*

Updated about 12 hours ago