Network APIBalances

Retrieve balance

Beta
<Warning title="Beta" icon="robot-astromech"> Balances is a **beta** feature. We're actively improving this API based on your feedback. </Warning> Retrieves a balance by its ID. Scopes: `BALANCES_READ`

Path parameters

balance_idstringRequired

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
Not Found Error