Retrieve account balance
Returns the current account balance including total, available, and locked amounts.
By default, the response does not include the list of individual locks.
To include the locks array, pass includeLocks=true as a query parameter.
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
Headers
Unix seconds. Required on the signed host; tolerance is 300s either way (403 request_timestamp_skew).
Lowercase hex SHA-256 of the body. An empty body hashes the empty string, so the header is always present. Mismatch returns 400 body_hash_mismatch.
Detached JWS (<protected>..<signature>, ES256 or PS256) over METHOD\nPATH?QUERY\nTIMESTAMP\nIDEMPOTENCY_KEY_OR_EMPTY\nX_CONTENT_SHA256.
Query parameters
When true, includes the locks array with details of each active lock.
Response
Total balance from the banking partner. Amount in BRL. Max 2 decimal places (e.g., 18254.17 for R$18.254,17).
Total locked amount (sum of active locks). Amount in BRL. Max 2 decimal places (e.g., 500.00 for R$500,00).
Available balance (total − locked). Amount in BRL. Max 2 decimal places (e.g., 17754.17 for R$17.754,17).