Loyalty Programs

A Loyalty Program is a collection of Promotions that reward accounts for completing certain actions. For example, a Loyalty Program could be set up to reward accounts with points every time they make a payment.

To set up a Loyalty Program and issue rewards, there are a few required steps:

1. Create Loyalty Program  API 
   • A Loyalty Program is a container for the Promotions that will be created in step 2.
2. Create Promotion(s)  API 
   • Promotions contain conditions, a target, and a reward.
3. Create Account  API 
   • This will be the account that will participate in the Loyalty Program.
4. Create Loyalty Program Membership for Account  API 
   • This will onboard the Account to the Loyalty Program. A Promotion Membership will be created for each Promotion under the Loyalty Program.
   • A Promotion Membership contains the progress for the Account towards completing the Promotion.
5. Create Events  API 
   • When Accounts perform actions, Events are generated that are used to increment progress on their Promotion Memberships. Centrapay generates some Events internally but you can use this API if you’d like to send us Events from your own application.
6. List Promotion Memberships for Account  API 
   • This will return the Account’s Promotion Memberships along with their current progress and whether they have been completed or not.

{
  "id": "L75M3L56N2PtBSt8g7uXLU",
  "accountId": "Jaim1Cu1Q55uooxSens6yk",
  "type": "payment-request:paid",
  "data": {
    "paymentAmount": "1000"
  },
  "idempotencyKey": "login-de32dd90-b46c-11ea-93c3-83a333b86e7b",
  "createdAt": "2020-05-01T12:30:00.000Z",
  "createdBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey"
}