GuidesAPI Reference
Guides
API Reference

Retrieve detailed balance breakdown

Provides a comprehensive, itemized breakdown of a beneficiary's balance in the specified currency. This includes available balance (funds that can be withdrawn immediately), pending balance (deposits or transactions being processed), reserved balance (funds held for pending outgoing transactions), recent transaction history affecting the balance, and projected available balance after pending items settle. Use this for detailed balance reconciliation or to explain balance discrepancies to users.

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 detailed balance for.

Query Params
string
required

Currency code (e.g., USD, BRL, MXN) to retrieve detailed 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