GuidesAPI Reference
Guides
API Reference

Retrieve beneficiary account balance

Returns the current balance for a beneficiary's account in the specified currency. The balance includes available funds (ready for withdrawal or payment) and may also show pending transactions that will affect the balance once settled. Use this before initiating transactions to verify sufficient funds or to display balance information in your user interface.

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

Unique identifier of the beneficiary to retrieve balance for.

Query Params
string
required

Currency code (e.g., USD, BRL, MXN) to retrieve balance for.

Response

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