API reference · Wallets

Read a wallet

GET/v1/wallets/{walletId}

One wallet and its balance.

Permissionwallets:read
AuthenticationSigned read
Staff-set limits it counts towardAll requests
.NET SDKanis.Wallets.GetAsync(walletId)

Parameters

NameInTypeNotes
walletIdrequiredpathUUIDA UUID, lower-case with hyphens.

Request

Signed with your key. No body, no nonce.

Headers: Signature-Input, Signature, X-Anis-Date, Accept-Language (optional). The SDKs set all of them for you.

Body: none.

Responses

StatusMeaningBody
200Success.Wallet
401Refused: not authenticated.Problem
403Refused: not allowed.Problem
404Refused: not found, or not yours.Problem
429Refused: a limit was reached.Problem
503No decision: a dependency was unavailable.Problem

Every answer is signed by Anis; the SDKs check it before you see it.

Refusals

Every refusal is a signed problem. Branch on its code; each links to what it means and what to do.

ErrorCodeStatus
Invalid credentialsinvalid_credentials401
Insufficient scopeinsufficient_scope403
Source address not allowedsource_ip_not_allowed403
Rate limitedrate_limited429
Account not authorisedbinding_not_authorized403
Account inactiveaccount_inactive403
Wallet not grantedwallet_not_granted404
Not foundresource_not_found404
Service unavailabledependency_unavailable503
Request timeoutrequest_timeout504
Internal errorinternal_error500

Types

Wallet

FieldTypeNotes
idalways presentUUIDThe wallet’s id. Every wallet-level call takes it in the address.
namealways presentstringThe wallet’s name.
currencyalways presentstringThe currency the wallet holds and buys in.
balancealways presentMoneyThe balance you can spend now, with the moment it was read.

Money

FieldTypeNotes
amountalways presentstringA decimal string with exactly three decimals, such as "10.500" — never a JSON number.
currencyalways presentstringThe currency code, such as LYD: always the wallet’s currency.
asOfstring (date-time)When this price or balance was read.