Balance
Query your current and historical account balances.
Base URL
| Environment | URL |
|---|---|
| Production | https://api-pix.crypto2pay.app/v2/balance |
| Sandbox | https://sandbox-pix.crypto2pay.app/v2/balance |
info
Balance endpoints are only available in production.
Current Balance
GET /v2/balance
Returns the current available balance for your account.
Headers
| Name | Description |
|---|---|
| Authorization | Your API key |
Example Request
curl --request GET \
--url https://api-pix.crypto2pay.app/v2/balance \
--header 'Authorization: YOUR_API_KEY'
Response 200
{
"transactional": {
"balance": 152340.5012,
"balances": [
{ "bank": "WALLET", "amount": 152340.5012 }
]
},
"operational": {
"balance": 0,
"balances": []
}
}
Response Fields
| Field | Type | Description |
|---|---|---|
transactional.balance | number | Your available account balance in BRL, with up to 4 decimal places |
transactional.balances[] | array | Always a single consolidated entry representing your wallet |
transactional.balances[].bank | string | Always WALLET — your consolidated account |
transactional.balances[].amount | number | Identical to transactional.balance |
operational.balance | number | Always 0 |
operational.balances[] | array | Always empty |
note
Your balance is reported as a single consolidated wallet. The full amount is returned under transactional with bank: "WALLET", while operational is always zero. Amounts are expressed in BRL with up to 4 decimal places.
Balance History
GET /v2/balance/history
Returns the opening and closing balance for your account on a specific date.
Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
date | string | required | Date in YYYY-MM-DD format |
Example Request
curl --request GET \
--url 'https://api-pix.crypto2pay.app/v2/balance/history?date=2026-06-01' \
--header 'Authorization: YOUR_API_KEY'
Response 200
{
"transactional": {
"date": "2026-06-01",
"balance": {
"opening": 118200.15,
"closing": 152340.5012
},
"balances": [
{
"bank": "WALLET",
"opening_balance": 118200.15,
"closing_balance": 152340.5012
}
]
},
"operational": {
"date": "2026-06-01",
"balance": {
"opening": 0,
"closing": 0
},
"balances": []
}
}
Response Fields
| Field | Type | Description |
|---|---|---|
transactional.date | string | The requested date (YYYY-MM-DD) |
transactional.balance.opening | number | Wallet balance at the start of the day (BRL) |
transactional.balance.closing | number | Wallet balance at the end of the day (BRL) |
transactional.balances[] | array | Always a single consolidated WALLET entry |
transactional.balances[].bank | string | Always WALLET |
transactional.balances[].opening_balance | number | Identical to transactional.balance.opening |
transactional.balances[].closing_balance | number | Identical to transactional.balance.closing |
operational.* | — | Always zero / empty |
Error Responses
| Status | Description |
|---|---|
400 | date query parameter is missing. |
400 | Invalid date format. Ensure the date follows YYYY-MM-DD. |
400 | The requested date is in the future. |
400 | The requested date is today. Use the current balance endpoint instead. |
note
All amounts are in BRL, with up to 4 decimal places. The business day runs from 00:00 to 23:59 UTC-3 (Brasília timezone). If there was no account activity on the requested date, both opening and closing carry over the previous day's closing balance.