Balance
The balance endpoints allow you to monitor the available funds in your account. This is essential for ensuring sufficient liquidity for operations like Pix withdrawals, boleto settlements, or card settlements.
The Balance model
The balance model provides a snapshot of the available, blocked, and pending amounts in your account. These values help you understand how much can be immediately used or is reserved for processing transactions.
Retrieve Balance
This endpoint allows you to retrieve your wallet balance, required filtered by parameters such as currency.
Available query parameters
- Name
currency
- Type
- integer
- Description
Optional Filter by currency (e.g.: "BRL", "USD", "EUR").
- Name
type
- Type
- string
- Description
Optional Filter by type (e.g.: "FIAT", "CRYPTO").
Request
curl -X POST https://api.domain.com/wallet/balance \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
Properties Response
- Name
statusCode
- Type
- number
- Description
Status code of request.
- Name
message
- Type
- enum
- Description
Status of the transaction (e.g.: "BALANCE_REQUEST", "ERROR").
- Name
data
- Type
- object
- Description
Includes details of your balance such as current, reserved and blocked balance
- Name
timestamp
- Type
- string (ISO 8601)
- Description
The date and time when the transaction was created.
Response
{
"statusCode": 201,
"message": "BALANCE_REQUEST",
"data": {
"current": 0,
"reserve": 0,
"currency": "BRL",
"type": "FIAT",
},
"timestamp": "2025-04-10T06:17:56.816Z"
}