API BaaSAccounts

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

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

accountIdstringRequired
Account identifier.

Headers

X-Tenant-IdstringRequired
Tenant context used for authorization and routing.

Query parameters

includeLocksbooleanOptionalDefaults to false

When true, includes the locks array with details of each active lock.

Response

Account balance retrieved.
accountIdstring
totaldouble

Total balance from the banking partner. Amount in BRL. Max 2 decimal places (e.g., 18254.17 for R$18.254,17).

lockeddouble

Total locked amount (sum of active locks). Amount in BRL. Max 2 decimal places (e.g., 500.00 for R$500,00).

availabledouble

Available balance (total − locked). Amount in BRL. Max 2 decimal places (e.g., 17754.17 for R$17.754,17).

currencystring
updatedAtdatetime

Errors

404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error
500
Internal Server Error
503
Service Unavailable Error
504
Gateway Timeout Error