Skip to navigation
Network APIBalances

Retrieve balance

Beta
Beta

Balances is a beta feature. We’re actively improving this API based on your feedback.

Retrieves a balance by its ID.

Scopes: BALANCES_READ

Path parameters

balance_idstringRequired
The ID of the balance to retrieve.

Headers

AcceptstringRequired
X-RegionstringRequired
X-SignaturestringRequired
User-AgentstringRequired

Query parameters

grant_idstringOptional1-256 characters

ID of the grant that authorizes reading the customer’s balances. This grant is created when a customer approves a CHECKING_BALANCE action in the Customer Request API.

Response

OK
balanceobject

Errors

404
Retrieve Balance Request Not Found Error