Sign in

v36

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-017439390.7 KB

This API processes the use of one or more coupons associated with a customer in Gameball. By providing customer details and a list of coupons, this endpoint marks the coupons as redeemed, completing the transaction. Optionally, a lockReference can be included to burn previously locked coupons.

post/api/v4.0/integrations/coupons/burn

Request body

customerIdstring required
emailstring
mobilestring
transactionIdstring

A unique identifier for the transaction in your system (e.g., order number or invoice number). This ID can be used to reverse, cancel, or refund any coupon burn transactions in Gameball.

transactionTimestring date-time

The time of the transaction in your system (e.g., order datetime, invoice datetime). Must be in UTC (ISO 8601 format).

couponsstring[]

List of coupons that need to be burned. Only one of coupons or lockReference must be provided.

lockReferencestring

Reference used to burn the locked coupons from the validation step. Only one of coupons or lockReference must be provided.

Example request

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

Response

Coupon burned successfully

successboolean
burnedAtstring date-time