Skip to main content
POST
/
api
/
v4.0
/
integrations
/
coupons
/
burn
cURL
curl --request POST \
  --url https://api.gameball.co/api/v4.0/integrations/coupons/burn \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --header 'secretkey: <api-key>' \
  --data '
{
  "customerId": "<string>",
  "email": "<string>",
  "mobile": "<string>",
  "transactionId": "txn98765",
  "transactionTime": "2024-10-11T10:57:43.382Z",
  "coupons": [
    "<string>"
  ],
  "lockReference": "<string>"
}
'
{
  "success": true,
  "burnedAt": "2023-11-07T05:31:56Z"
}
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.
Channel Merging Available
If your system uses different customer IDs across multiple channels (e.g., online and offline), Gameball’s channel merging feature helps unify customer profiles. By including the customer’s mobile number or email (based on your merging configuration) with each request, Gameball will combine activities into a single profile.For more information, head to the Omni-Channel Handling Guide.
Security: Requires apikey and secretkey headers.

Authorizations

​
apikey
string
header
required
​
secretkey
string
header
required

Body

application/json
​
customerId
string
required
​
email
string
​
mobile
string
​
transactionId
string

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.

Example:

"txn98765"

​
transactionTime
string<date-time>

The time of the transaction in your system (e.g., order datetime, invoice datetime).

Example:

"2024-10-11T10:57:43.382Z"

​
coupons
string[]

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

​
lockReference
string

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

Response

200 - application/json

Coupon burned successfully

​
success
boolean
​
burnedAt
string<date-time>