Get wallet credits

Returns the current wallet balance of the workspace.

GET

https://api.zacx.io/v1/workspace/wallet_balance

View as Markdown

Authorisation

bearerAuthHTTPrequired

Returns

200

The balance.

JSON

statusstringrequired
dataobjectrequired
2 properties
- balancenumberrequired
  Available credits.
- currencystringrequired
  ISO 4217 currency code.

401

The API key is missing or invalid.

JSON

statusstringrequired
codestringrequired
Stable machine-readable error code.
messagestringrequired
Human-readable explanation.

Get wallet credits

curl --request GET \
  --url https://api.zacx.io/v1/workspace/wallet_balance \
  --header 'Authorization: Bearer <token>'

const url = 'https://api.zacx.io/v1/workspace/wallet_balance';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

Response example

{
  "status": "success",
  "data": {
    "balance": 1234.23,
    "currency": "INR"
  }
}

{
  "status": "error",
  "code": "VALIDATION_FAILED",
  "message": "string"
}