Skip to main content

Balance

Query your current and historical account balances.

Base URL

EnvironmentURL
Productionhttps://api-pix.crypto2pay.app/v2/balance
Sandboxhttps://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

NameDescription
AuthorizationYour 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

FieldTypeDescription
transactional.balancenumberYour available account balance in BRL, with up to 4 decimal places
transactional.balances[]arrayAlways a single consolidated entry representing your wallet
transactional.balances[].bankstringAlways WALLET — your consolidated account
transactional.balances[].amountnumberIdentical to transactional.balance
operational.balancenumberAlways 0
operational.balances[]arrayAlways 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

NameTypeRequiredDescription
datestringrequiredDate 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

FieldTypeDescription
transactional.datestringThe requested date (YYYY-MM-DD)
transactional.balance.openingnumberWallet balance at the start of the day (BRL)
transactional.balance.closingnumberWallet balance at the end of the day (BRL)
transactional.balances[]arrayAlways a single consolidated WALLET entry
transactional.balances[].bankstringAlways WALLET
transactional.balances[].opening_balancenumberIdentical to transactional.balance.opening
transactional.balances[].closing_balancenumberIdentical to transactional.balance.closing
operational.*Always zero / empty

Error Responses

StatusDescription
400date query parameter is missing.
400Invalid date format. Ensure the date follows YYYY-MM-DD.
400The requested date is in the future.
400The 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.