Appearance
Wallets
Current, held and available balance of one wallet
GET
/api/v1/tenant/wallets/{uid}/balanceScope wallets:read
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
uid | string | yes |
Response · 200
| Field | Type | Description |
|---|---|---|
walletUid | string | |
currency | string | |
current | string | A decimal amount with two decimal places. |
held | string | A decimal amount with two decimal places. |
available | string | The only figure a debit is authorized against. |
status | enum | One of pending, active, debit_blocked, credit_blocked, frozen, dormant, closed. |
asOf | string | When 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.