Skip to main content

WalletAccount

A wallet and its ledger balances

accountIdstring<uuid>

Unique identifier of the wallet

currencystring

Currency code

Example: AED
postedBalancestring

Posted balance, including reserved funds. May include postings newer than visibleThrough

Example: 1250.00
reservedBalancestring

Funds reserved for payments in progress

Example: 100.00
pendingHoldsstring

Card and other holds not yet posted

Example: 0.00
availableBalancestring

Posted balance minus reserved balance minus pending holds

Example: 1150.00
visibleThroughstring<date-time>

Nothing posted after this instant is returned yet by the entries feed, whether a posted entry or a reservation event

historyStartstring<date-time>

Posting time of the wallet's first visible entry

namestring | nullnullable

Label of your own, set when the wallet was opened. Absent on the primary wallet of a currency

Example: Customer 42
externalIdstring | nullnullable

Your own reference, set when the wallet was opened. Absent on the primary wallet of a currency

Example: cust-42
statusstring

Lifecycle status of the wallet

Possible values: [OPENING, OPEN, FAILED, CLOSED]

WalletAccount
{
"accountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"currency": "AED",
"postedBalance": "1250.00",
"reservedBalance": "100.00",
"pendingHolds": "0.00",
"availableBalance": "1150.00",
"visibleThrough": "2024-07-29T15:51:28.071Z",
"historyStart": "2024-07-29T15:51:28.071Z",
"name": "Customer 42",
"externalId": "cust-42",
"status": "OPENING"
}