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
AuthorizationBearer
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
accountId
Account identifier.
Headers
X-Tenant-Id
Tenant context used for authorization and routing.
Query parameters
includeLocks
Accepted for compatibility and ignored. The response never carries a locks array.
Response
Account balance retrieved.
accountId
total
Total balance from the banking partner. Amount in BRL. Max 2 decimal places (e.g., 18254.17 for R$18.254,17).
locked
Total locked amount (sum of active locks). Amount in BRL. Max 2 decimal places (e.g., 500.00 for R$500,00).
available
Available balance (total − locked). Amount in BRL. Max 2 decimal places (e.g., 17754.17 for R$17.754,17).
currency
updatedAt
Errors
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error
500
Internal Server Error
502
Bad Gateway Error
503
Service Unavailable Error
504
Gateway Timeout Error