Explore Knowledge Base

Accounts (wallets)

26. 12. 2024

Accounts in the system (also called as Wallets and Coin (in the code) are in-system accounts – which represent balance. 

The wallet can be at any level – system, merchant, referrer, gate etc. In the code, wallet is named as a coin.

Please note that Accounts are not bank accounts in their traditional meaning. 

There are two main types of Accounts – Clients’ Wallets and System Accounts

The coin attributes are: 

{
  "coins": [
    {
      "serial": "string",
      "name": "string",
      "amount": 0,
      "availableAmount": 0,
      "futureAmount": 0,
      "heldAmount": 0,
      "creditLimit": 0,
      "currency": {
        "id": "string",
        "sn": "string",
        "code": "string",
        "symbol": "string",
        "type": "FIAT"
      },
      "active": true,
      "type": "client",
      "main": true,
      "accounting": true,
      "smartCards": [
        {
          "id": "string",
          "cardNumber": "string",
          "expirationDate": "string",
          "name": "string",
          "expirationStatus": "ACTIVE",
          "active": true
        }
      ],
      "deactivationDate": "2024-12-16T11:26:23.090Z",
      "deactivationReason": "other"
      "deactivationDescription": "string"
    }
  ]
}

Where: 

serial Unique serial number of the wallet generated by the system
name Name of the account set by the user
amount Total balance of the wallet
availableAmount Amount available for spending (in cases when some funds are on hold)
futureAmount
heldAmount
creditLimit
currency Currency of the wallet
active true /false – shows if the account is active or deactivated
type Account type, such as client, Issuing_balance, reserve etc. 
main true /false – shows if the account was  set as main account of the client or not 
accounting true/false – indicates whether the account is used in the accounting (true) or in circulation (false)
smartCards Lists the information about the smart cards, linked to the account (if any)
deactivationDate

deactivationReason

deactivationDescription

For deactivated accounts, shows the date, reason and description for deactivation.