Using Gameball Couponing Engine

Gameball's couponing engine provides a powerful way to manage coupon creation, validation, and redemption through API integrations. With it, you can validate, lock, burn, and release coupons seamlessly, offering flexibility for both simple and complex redemption flows.

Before using the couponing engine via API, it must first be set up from the Gameball dashboard. This includes creating, managing, and configuring coupons, ensuring that your system is ready to handle coupon-based promotions effectively.

Once configured, the API can be used to integrate coupons into your system for smooth, automated validation and redemption processes.

Gameball Couponing Engine Integration Example

This example illustrates how to integrate Gameball’s couponing engine using a sequence of actions, allowing for coupon validation, locking, burning, and releasing.

Step 1: Validate One or More Coupons

The first step is to validate whether one or more coupons are valid for a customer. You can also lock the coupon(s) for later redemption by setting the lock flag to true. If successful, the system returns a holdReference, which will be used for burning the coupon later.

Example 1: Single Coupon

• Customer wants to redeem the coupon SAVE10.

Endpoint: Validate Single Coupon

Example Body:

{
  "customerId": "customer123",
  "mobile": "010XXXXXXXX",
  "email": "[e-mail]",
  "lock": true,
  "holdReference": null
}

---

Example 2: Multiple Coupons (Optional)

• Customer wants to redeem two coupons: SAVE10 and FREESHIP.

Endpoint: Validate Multiple Coupons

Example Body:

{
  "customerId": "customer123",
  "coupons": ["SAVE10", "FREESHIP"],
  "lock": true,
  "holdReference": null
}

In both cases, if the coupon(s) are valid and locked, you'll receive a holdReference that you can use in the next step.

---

Step 2: Burn or Release the Coupons

Once you have validated and locked the coupon(s), you have two possible actions depending on the customer’s decision:

• Burn the Coupon: If the customer completes the transaction, use the holdReference to burn the coupon, finalizing its redemption and applying the discount.

Endpoint: Burn Coupons

Example Body:

{
  "holdReference": "generatedHoldReference"
}

---

• Release the Coupon: If the customer decides not to proceed, you can release the coupon, making it available for future use. This is also useful if the coupon was locked but the transaction didn’t go through.

Endpoint: Release Coupons

Example Body:

{
  "holdReference": "generatedHoldReference"
}

---

Summary of the Integration Flow:

1. Validate and lock one or more coupons for a customer in a single step.

2. Depending on the outcome:

   • Burn the coupon to finalize the redemption if the customer completes the transaction.

   • Release the coupon if the transaction is not completed, making it available for future use.

For further details, please refer to the Coupon API documentation.

---