Wallet

Wallet Model

A wallet is an account that contains the total amount collected by businesses on Vendy. They are created automatically upon activation of businesses. There are two types of wallet created for businesses:

• Balance Wallet: Total amount for a transaction is credited into this wallet.
• Commission Wallet: A commission is paid into the commission wallet for each transaction conducted via Vendy

Field	Type	Description	Nullable
id	Integer	A unique identifier for interacting with wallet	false
ownerid	Integer	Unique identifier for business associated with wallet	false
uid	Integer	A unique Identifier for wallet	false
businessId	Integer	Unique identifier for business associated with wallet	false
balance	Double	Total current amount in wallet	false
lockedBalance	Double	Amount unavailable for withdrawal in wallet	false
meta	JSON	Extra data on wallet	true
pendingInflow	Double	Pending amount to be deposited into wallet	false
pendingWithdrawal	Double	Pending amount to be withdrawn from wallet	false
availableBalance	Double	Amount available for withdrawal in wallet	false
status	Enum(String)	Current state of wallet: 'active', 'pending', 'blocked' or 'outflow-only'	false
type	Enum(String)	Type of wallet: 'commission' or 'balance'	false
currency	String	3 letters ISO currency code	false
fee	Double	Standard fee charge for business on transactions	false
createdAt	Date(String)	Date of creation of wallet	false
updatedAt	Date(String)	Most recent date of update on wallet	false
deletedAt	Date(String)	Date of deletion of wallet	true

Sample Wallet Response

JSON

{
    "id": 1687,
    "ownerid": 899,
    "uid": 1008,
    "businessId": 899,
    "balance": 0,
    "lockedBalance": 0,
    "meta": null,
    "pendingInflow": 0,
    "pendingWithdrawal": 0,
    "availableBalance": 0,
    "status": "active",
    "type": "balance",
    "currency": "ngn",
    "fee": 0.015,
    "createdAt": "2023-04-04T15:23:04.000Z",
    "updatedAt": "2023-04-04T15:23:04.000Z",
    "deletedAt": null
}