API Reference

Create e-wallets for your customers

With Wallets you can create as many e-wallets as required on across your platforms. Wallets serve as the foundation for all loyalty campaigns created and help you keep track of all earning and redeeming transactions done by your customers.

In this section we will take you through the process of creating a wallet and how it can be used with referral and loyalty campaigns.

Create a Wallet

To create a wallet:

  1. Click Wallets on the left panel of the dashboard to access the wallet page.
  2. Click +Add New on the top right corner of the screen.
  3. In Wallet Name, type the name you want to give to the wallet.
  4. In Description (optional), describe what the wallet will be used for.
  5. In Timezone, select the reference timezone for transactions occurring in the wallet. The timezone will be used to display the timestamp of all transactions, point activation and expiration date, and dashboard analytics.
  6. In Reward points name, select the singular and plural name of the wallet currency (eg. diamond/diamonds, ton/tonnes, point/points)
  7. In Reward points currency conversion(optional), you can set the conversion factor between wallet's digital unit and currency. The currency displayed will be as per the currency set in the project settings.
  8. In Points Expiration Date/Time, select if the points never expire or expire on a relative date.
    1. All points deposited in this wallet from any campaign will follow the expiration rule set
    2. Type the number of days you want to expire the points after the user is rewarded.
    3. All expirations happen at the end of the expiry day, 23:59:99.
  9. Select Create Wallet.
Create Custom Wallet

Create Custom Wallet

View and Edit Created Wallets

To view or edit a wallet,

  1. Click on Walleton the left panel of the dashboard
  2. All created wallets will be in the table.
  3. To edit wallet settings, click Edit
  4. Except for Timezone, all wallet settings can be edited.
  5. To view wallet analytics and transaction history, click on the wallet name.
    Wallet History
    1. Points Awarded - All points awarded till date to customers
    2. Points Active - All points that are currently available to use in customer's wallets
    3. Points Dormant - All points that are awarded to customer but yet to be available to use
    4. Points Expired - All points awarded to customers that have expired
      Transaction History
    5. User - User id attached to the transaction
    6. Timestamp - Date and time of the transaction
    7. TXN ID - Identification number for the transaction
    8. Quantity - Number of units transacted
    9. Action - Transaction type: Added or Redeemed
Wallet and Transaction History

Wallet and Transaction History