post
https://stagingstores.xoxoday.com/chef/v1/oauth/api
Balance API allows you to fetch the available balance in your Admin wallet
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Response Schema
| Path | Type | Description |
|---|---|---|
| data | object | Root response object. |
| data.getBalance | object | Container for balance details. |
| data.getBalance.status | number | API execution status (1 = success). |
| data.getBalance.data | object | Balance information object. |
| data.getBalance.data.value | number | Available balance value. |
| data.getBalance.data.currency | string | Currency code of the balance (e.g., USD). |
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.