Wallets

Confirm whose wallet an account number is

GET/api/v1/tenant/wallets/lookup

Scope wallet-transfers:write

Returns the masked name of the holder of the wallet with this account number, so the paying customer can confirm the payee before a transfer. A name comes back only for a wallet that can receive a transfer now; any other number is a 404, and a number that is not 13 digits with a valid check digit is a 400. The answer never carries the wallet's uid, status, KYC level or balance. Lookups are limited per account per minute; beyond the limit the answer is 429 until the next minute.

Query parameters

Name	Type	Required	Description
accountNumber	string	yes	The 13-digit account number the customer wants to pay

Response · 200

Field	Type	Description
maskedDisplayName	string	The name of the wallet's holder, masked: the first name, then the initials of the rest. Show it to the paying customer to confirm the payee.

Example (placeholder values)

{
  "maskedDisplayName": "Abebe B."
}

Errors

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

Current, held and available balance of one wallet

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

Scope wallets:read

Path parameters

Name	Type	Required	Description
uid	string	yes

Response · 200

Field	Type	Description
walletUid	string
accountNumber	string	The wallet's 13-digit account number, the last digit a check digit. It never changes and is never reused; it is the number a person gives to be paid into this wallet.
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)

{
  "walletUid": "01J9Z3K5X8QW2R4T6V8Y0B1C3D",
  "accountNumber": "6695731439148",
  "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.