wallet

Read the prepaid wallet balance

Read the organization's prepaid wallet balance in ZAR cents and in credits.

Balance is returned in both denominations: balance_zar_cents (the money contract) and balance_credits (whole credits, rounded down).

credit_zar_cents is the fixed conversion rate (1 credit = 5 ZAR cents), so balance_credits = floor(balance_zar_cents / credit_zar_cents).

enforced reports whether sends are metered against the wallet; when false, sends are neither blocked nor debited.

Reads require the wallet:read scope. Top-ups and balance changes are dashboard-only.

get/api/v1/wallet

Request

  • Base URL: https://app.blueticked.com
  • URL: https://app.blueticked.com/api/v1/wallet
  • Auth: HTTP bearer

Response

Success

plan_credit_zar_centsnumber required
plan_creditsnumber required
total_zar_centsnumber required
total_creditsnumber required
currency'ZAR' required
balance_zar_centsnumber required
balance_creditsnumber required
credit_zar_centsnumber required
low_threshold_zar_centsnumber nullable required
enforcedboolean required
request_idstring required

Example response

{
  "balance_zar_cents": 20000,
  "balance_credits": 4000,
  "credit_zar_cents": 5,
  "low_threshold_zar_cents": 5000,
  "request_id": "req_b2e3d610e10f1b07468721ee98f0e1d2"
}

Changes

No recorded changes to this operation across all 1 revision of this API.