Explore Knowledge Base

Account (wallet) types

26. 12. 2024

Wallet – internal wallet in SDK which represents balance. Wallet can be at any level – system, merchant, individual, gate etc. In the code, wallet is named as coin.

Wallet type – represents the type of the wallet by its designation. Organisation – means which organisation can have such a wallet type. 

Level – means on which level the wallet is used (gate, operation, system, business user) it is the logical level of the account and is not linked with a certain organization.

Usage – Indicates if the account is used for accounting or for circulation. 

Collector – shows the recipient of the collected commission. 

Wallet type Organization Description Level Usage Collector
regular_gate_commission system, gate-provider Wallet for Individuals gate operations commission.

It is used for calculations of commission income for specified 3rd party provider and specific commission collector.

Receiver of the commission depends on the collector parameter for this wallet type:

  • PROVIDER – commission is paid to the third-party provider
  • SDK_FINANCE – commission is paid to the system
  • TOTAL – total commission paid by the customer

It is created automatically for the definite currency when commission for gate operation is configured in any contract

gate Accounting Provider
business_gate_commission system, gate-provider Wallet for Merchants gate operations commission.

It is used for calculations of commission income for specified 3rd party provider and specific commission collector.

Receiver of the commission depends on the collector parameter for this wallet type:

  • PROVIDER – commission is paid to the third-party provider
  • SDK_FINANCE – commission is paid to the system
  • TOTAL – total commission paid by the customer

It is created automatically for the definite currency when commission for gate operation is configured in any contract

gate Accounting Provider
technical_transit system Transit wallet for money movement consistency. When the operation is completed the balance of this account must be 0.

It is created automatically for each operation.

operation Circulation
client_system_commission individual, merchant wallet to account internal system commission

wallet is created along with client wallet or during operation processing if not exists

business user circulation
issuing_balance system Wallet for money issued in the system (shows circulation money volume).

It is created automatically for the definite currency when commission for any operation is configured in any contract

system Accounting
debt_gate_settlement gate Wallet to account money that the system paid to provider because provider commission is greater than commission deducted from the client. Such operation is possible if debtAllowed=true for the provider. This wallet allows negative balance.

It is created automatically for the definite currency when commission for gate operation is configured in any contract

gate accounting
debt_gate_commission gate Wallet to account provider commission that is not covered by commission deducted from the client, because provider commission is greater than commission deducted from the client. Such operation is possible if debtAllowed=true for the provider.

It is created automatically for the definite currency when commission for gate operation is configured in any contract

gate Accounting Provider
exchange_reserve system Wallet for exchange reserve for  Currency Exchange operation.

It is created automatically for the definite currency when commission for currency exchange operation is configured in any contract

system Circulation
client individual, merchant Wallets owned by business users (individual, merchant).

It is created by the business user or by the service user on behalf of the business user.

Business user (Individual, merchant) Circulation
gate gate-provider Wallet for provider settlement money flow for gate operations. Works as transit account and when operation is completed balance of this wallet should be 0.  gate Accounting
reserve system Wallet for cash which is being transferred between cash desks.

It is created automatically for the definite currency when commission for cash desc operation is configured in the any contract for any cash desk.

system Circulation
cash cash desk, merchant*

 

*merchant  – as legacy logic

Wallet for cash desk. It is created  automatically:

  • for existing cash desks for the definite currency, when commission for cash desk operation is configured in any contract
  • when new cash desk is created, for all currencies, for which commissions for cash desk operations are configured at the moment of cash desk creation.

Cash desk operations: cash_desk_redeem  cash_desk_charge

cash desk Accounting
prepaid individual, merchant Special type of the wallet for prepaid vouchers.

It is created when user creates prepaid voucher.

Prepaid vouchers allow business users to purchase a voucher with a specific denomination and redeem it for goods or services later on.

client Circulation