Object

The wallet object

Fields

idstringrequired

Starts with wal_.

objectstringrequired

user_idstringrequired

Starts with usr_.

assetstringrequired

A wallet asset code. The set is data on GET /routes. In 1.0 it holds two assets:

ndeipi-points: Ndeipi Points, bought with fiat on Absa or PayPal at a fixed price per currency and cashed out the same way. Every user's default asset.
ndeipi-coin: NdeipiCoin, opt-in. Its price moves. It is bought and sold only by converting points at a locked quote (POST /quotes), never directly with fiat. A wallet needs acknowledge_price_risk: true to create.

decimalsintegerrequired

Decimal places this asset's amounts may carry.

statusstringrequired

frozen while the owner is deactivated or under compliance hold.

One of active, frozen.

balanceWalletBalancerequired

price_risk_acknowledged_attimestamp | null

For ndeipi-coin wallets, when the user acknowledged the price risk.

metadataobject

Integrator key-value data, returned unchanged. Up to 50 keys; keys up to 40 characters, values up to 500.

versionintegerrequired

created_attimestamprequired

Example

{
  "id": "wal_01JA8Z4K2V9QW3H6Y7XKD2M0RS",
  "object": "wallet",
  "user_id": "usr_01JA8Z2F5G6H7J8K9M0N1P2Q3R",
  "asset": "ndeipi-points",
  "decimals": 2,
  "status": "active",
  "balance": {
    "object": "wallet_balance",
    "wallet_id": "wal_01JA8Z4K2V9QW3H6Y7XKD2M0RS",
    "asset": "ndeipi-points",
    "available": "75.00",
    "pending": "0.00",
    "cashable": "60.00",
    "as_of": "2026-10-16T09:30:02Z"
  },
  "price_risk_acknowledged_at": null,
  "metadata": {},
  "version": 1,
  "created_at": "2026-10-16T09:30:00Z"
}