Skip to content

Wallets ​

Current, held and available balance of one wallet ​

GET/api/v1/tenant/wallets/{uid}/balance

Scope wallets:read

Path parameters ​

NameTypeRequiredDescription
uidstringyes

Response · 200 ​

FieldTypeDescription
walletUidstring
currencystring
currentstringA decimal amount with two decimal places.
heldstringA decimal amount with two decimal places.
availablestringThe only figure a debit is authorized against.
statusenumOne of pending, active, debit_blocked, credit_blocked, frozen, dormant, closed.
asOfstringWhen the balance last changed.
Example (placeholder values)
json
{
  "walletUid": "01J9Z3K5X8QW2R4T6V8Y0B1C3D",
  "currency": "ETB",
  "current": "2500.00",
  "held": "0.00",
  "available": "2500.00",
  "status": "pending",
  "asOf": "string"
}

Errors ​

400 401 403 404 429 500 503 — one body shape for all of them, see Errors.