Direct debit redemption

If you opt not to use the coupon system integration, you can implement redemption directly within your system using direct redemption. This guide will assist you in redeeming your customers' points through this method. However, we recommend following the coupon system integration guide as it provides a more straightforward, secure, and seamless experience.

Overview of Direct Redemption

Through Gameball, customers can redeem and use their accumulated points as discounts during the checkout process on your website. This feature enhances customer engagement by facilitating a rewarding shopping experience.Lets go over how this can be done.

Integration Walkthrough

1. View Customer Points Balance Enabling customers to view their points balance is crucial for an optimal redemption experience. This transparency helps customers track their progress toward rewards. You can retrieve a customer's current points balance using the Customer's Points Balance API

var balanceResponse = {
    "totalPointsBalance": 1500,
    "totalPointsValue": 75.0,
    "availablePointsBalance": 1200,
    "availablePointsValue": 60.0,
    "pendingPoints": 300,
    "pendingPointsValue": 15.0,
    "currency": "USD",
    "pointsName": "Reward Points",
    "nextExpiringPointsAmount": 200,
    "nextExpiringPointsValue": 10.0,
    "nextExpiringPointsDate": "2024-12-01T00:00:00",
    "totalEarnedPoints": 2500
}

---

2. Validate Customer Balance

You can use the result from the previous step to verify whether the points a customer wishes to redeem exceed their available points balance:

var actualPoints = balanceResponse["availablePointsBalance"];
var pointsToRedeem = 60; // points the customer wishes to redeem

if (pointsToRedeem > actualPoints) {
    // Display an error to the customer indicating insufficient points
}

---

3. Customer Redemption Scenarios

   • Direct Redemption Redeem points instantly by calling the Redeem API, specifying the desired points or amount to redeem.This directly deducts the points from the customer’s balance.

     {
       "customerId": "cust_12345abc",
       "transactionId": "txn98765",
       "transactionTime": "2024-10-11T10:57:43.382Z",
       "points": 100
     }

     The response body returns both the equivalent points and redemption amount that the customer has successfully redeemed.

     {
         "customerId": "cust_12345abc",
         "gameballTransactionId": "11034734",
         "transactionId": "txn98765",
         "redeemAmount": 10,
         "redeemEquivalentPoints": 100
     }

   • Holding Points for Later Redemption Use the Hold Points API to temporarily reserve points from the customer’s balance for 15 minutes or until the hold is released or redeemed, whichever occurs first.

     {
       "customerId": "cust_abc12345xyz67890",              
       "transactionTime": "2024-10-11T16:15:15.071Z",
       "pointsToHold": 100                       
     }

   • When the customer is ready to redeem, provide the hold reference to the /redeem endpoint to finalize the redemption.

   • Holding Points for Order Placement Similarly, hold points with the Hold Points API to reserve them from the customer’s balance. Once the customer completes the checkout process, use the hold reference in the /order endpoint to apply the held redemption amount to that specific order.

• Hold API Request Body:

{
    "amount": 98.89
}

Upon successful order completion, you will release the hold by referencing the hold ID provided in the Hold API response:

{
    "holdReference": "ref_12343ds"
}

2. Use Case: Redeem Points at a Custom Redemption Page If you prefer to create a dedicated page for point redemption, utilize the Redeem API to process points from the customer’s wallet balance and generate discount coupons equivalent to the redeemed amount.

Redeem API Request Body:

{
    "amount": 100
}

This process can also incorporate the flow for holding points before redemption.

---

Important Operations to Consider

• Reverse Transaction: If you need to cancel or refund a redeemed points transaction, store the original transaction ID and use the Reverse Points Transactions API.

• Reverse Hold Transaction: If necessary, reverse the hold transaction within the 10-minute window using the Reverse Hold Transaction API.

We recommend that you follow the coupon system integration guide instead of using direct redemption since it is easier, safer and more smooth