Get group balance

Purpose

Use this call to read the balance of the group the token belongs to, for example to show it in your own back office.

Request

POST <API_BASE_URL>/user/balance. All calls are POST under your API address. Replace <API_BASE_URL> with the API address provided with your access.

This operation takes no permanent API token. Send a user token in the token header. See authentication and user authorization.

The body has no fields.

Response

HTTP 200. The balance of the group of the caller.

Field	Type	Description
`status`	string	Always `ok` on this body.
`message`	string	Human-readable detail. Never branch on it.
`balance`	number	The balance in whole currency units. Zero when nothing is stored.

Errors

400: The request body failed validation.
401: The token is missing, expired or unknown.

A refusal can also come before the operation runs: an address outside your IP allowlist, a token bound to another address, or a body that is not valid JSON. See response format and errors.

Example

Request:

curl -X POST "<API_BASE_URL>/user/balance" \
  -H "token: <your user token>" \
  -H "Content-Type: application/json"

Response:

{
  "status": "ok",
  "message": "<detail>",
  "balance": 100
}