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.

GET/api/balance

Retrieve Balance

Returns current balance with breakdowns. Send required headers on every call.

Authorizations

Name
x-api-key
Type
string (header)
Description
Required Project API key sent in x-api-key header.
Name
x-token
Type
string (header)
Description
Required Session token sent in x-token header.

Available query parameters

Name
currency
Type
string
Description
Optional Filter by currency (e.g.: "BRL", "USD", "EUR").
Name
type
Type
string
Description
Optional Filter by type (e.g.: "FIAT", "CRYPTO").

Request

GET

/api/balance

curl --request GET \
  --url https://my.domain.io/api/balance \
  --header 'x-api-key: <api-key>' \
  --header 'x-token: <api-key>'

Properties Response

Balance returned.

Name
code
Type
integer
Description
Status code of the response. Example: 200.
Name
content
Type
object
Description
Balance details.
Name
content.currency
Type
string
Description
Balance currency (e.g.: "BRL").
Name
content.balance
Type
number
Description
Available balance.
Name
content.blocked
Type
number
Description
Blocked balance.
Name
content.reserve
Type
number
Description
Reserved balance.
Name
content.processing
Type
number
Description
Processing balance.
Name
message
Type
string
Description
Response message.
Name
timestamp
Type
string (date-time)
Description
Response timestamp.

200

{
  "code": 200,
  "content": {
    "currency": "BRL",
    "balance": 1250.75,
    "blocked": 120.0,
    "reserve": 80.0,
    "processing": 45.5
  },
  "message": "Balance returned",
  "timestamp": "2025-02-19T17:15:26.703Z"
}