All developer pages

API reference

Wallet

1 operations. Base URL: https://api.ringura.com/api/v1. Authenticate with a bearer token that carries the scope named on each operation.

GET /api/v1/wallet

The prepaid balance, as strings of minor units.

Scope
wallet:read
Operation id
getWallet

Response

200 JSON with these fields.

Response fields of GET /api/v1/wallet
FieldTypeRequiredConstraints
currencystring or nullYes
availableMinorstring or nullYes
reservedMinorstring or nullYes
thresholdMinorstring or nullYes
voiceRefusalstring or nullYes
messagesRefusalstring or nullYes

Errors

400, 401, 403, 404, 409, 429. What each status means

Example request

curl -X GET 'https://api.ringura.com/api/v1/wallet' \
  -H "Authorization: Bearer $CC_TOKEN"