The wallet information of a given user

Wallet Object

  "_id": "63dcf61dd56a212e285aa2b4",
  "test_mode": true,
  "balance": 0,
  "currency": "EUR",
  "auto_top_up": {
    "active": false,
    "payment_method": null,
    "minimum_balance": 0,
    "amount": 1000
    "wallet_amount": 1500
  "createdAt": "2023-02-03T11:55:07.474Z",
  "updatedAt": "2023-02-03T12:15:56.223Z"


_id string

The Id of this Wallet

test_mode boolean

Whether the wallet is created in test_mode or not.

balance number

Current wallet balance

currency string

3 letter iso currency codes. See If you do not see your currency listed, please contact support.

auto_top_up object

  • active: boolean If the auto top-up is enabled or not for this wallet
  • payment_method: string Use the payment_method if the wallet top-up is enabled
  • minimum_balance: number Trigger the auto top-up when the balance goes below this amount
  • amount: number Amount charged to a specified payment_method
  • wallet_amount: number Amount updated when the payment_method is charged successfully by the above specified property