Skip to main content

Balance

Query your current and historical account balances.

Base URL

EnvironmentURL
Productionhttps://api-pix.crypto2pay.app/v2/balance
info

Balance endpoints are only available in production.


Current Balance

GET /v2/balance

Returns the current balance for your account, broken down by bank.

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": 2222222.21,
"balances": [
{ "bank": "STARKBANK", "amount": 1234567.89 },
{ "bank": "GENIAL", "amount": 0 },
{ "bank": "EFIPAY", "amount": 987654.32 }
]
},
"operational": {
"balance": 2222222.21,
"balances": [
{ "bank": "STARKBANK", "amount": 1234567.89 },
{ "bank": "GENIAL", "amount": 0 },
{ "bank": "EFIPAY", "amount": 987654.32 }
]
}
}

Response Fields

FieldTypeDescription
transactional.balancenumberTotal transactional balance across all banks
transactional.balances[]arrayPer-bank breakdown of transactional balances
operational.balancenumberTotal operational balance across all banks
operational.balances[]arrayPer-bank breakdown of operational balances

Balance History

GET /v2/balance/history

Returns the opening and closing balances for a specific date, broken down by bank.

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-08-11' \
--header 'Authorization: YOUR_API_KEY'

Response 200

{
"date": "2026-08-11",
"transactional": {
"opening": {
"balance": 2000000.00,
"balances": [
{ "bank": "STARKBANK", "amount": 1000000.00 },
{ "bank": "GENIAL", "amount": 0 },
{ "bank": "EFIPAY", "amount": 1000000.00 }
]
},
"closing": {
"balance": 2222222.21,
"balances": [
{ "bank": "STARKBANK", "amount": 1234567.89 },
{ "bank": "GENIAL", "amount": 0 },
{ "bank": "EFIPAY", "amount": 987654.32 }
]
}
},
"operational": {
"opening": {
"balance": 2000000.00,
"balances": [
{ "bank": "STARKBANK", "amount": 1000000.00 },
{ "bank": "GENIAL", "amount": 0 },
{ "bank": "EFIPAY", "amount": 1000000.00 }
]
},
"closing": {
"balance": 2222222.21,
"balances": [
{ "bank": "STARKBANK", "amount": 1234567.89 },
{ "bank": "GENIAL", "amount": 0 },
{ "bank": "EFIPAY", "amount": 987654.32 }
]
}
}
}

Error Responses

StatusDescription
400Invalid date format. Ensure the date follows YYYY-MM-DD.
note

All amounts are in BRL. Daily closing is at midnight UTC-3 (Brasília timezone). Balances are updated in real time.