Get Balance API

Balance API allows you to fetch the available balance in your Admin wallet

Note
Rather than fetching the balance before every order, you can use the Low Balance Notification option in the Admin Dashboard to receive alerts when the balance reaches the set threshold. Click here to know more.

Response Schema

PathTypeDescription
dataobjectRoot response object.
data.getBalanceobjectContainer for balance details.
data.getBalance.statusnumberAPI execution status (1 = success).
data.getBalance.dataobjectBalance information object.
data.getBalance.data.valuenumberAvailable balance value.
data.getBalance.data.currencystringCurrency code of the balance (e.g., USD).
Language
Credentials
OAuth2
Click Try It! to start a request and see the response here!