Retrieve account balance
Returns the current account balance including total, available, and locked amounts.
locked is the total held (for example a MED hold); the response
does not list individual locks. includeLocks is accepted for
compatibility and has no effect.
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
Accepted for compatibility and ignored. The response never carries a locks array.
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).