Skip to main content
POST
/
api
/
v4.0
/
integrations
/
coupons
/
{code}
/
burn
cURL
curl --request POST \
  --url https://api.gameball.co/api/v4.0/integrations/coupons/{code}/burn \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '
{
  "customerId": "<string>",
  "email": "<string>",
  "mobile": "<string>",
  "lockReference": "<string>",
  "pin": "<string>"
}
'
{
  "success": true,
  "burnedAt": "2023-11-07T05:31:56Z"
}
This API marks a coupon as used/consumed, preventing it from being used again. This is typically called after a successful transaction to ensure the coupon cannot be reused.
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 Channel Merging Guide.

Path Parameters

code
string
required
The coupon code to burn/mark as used.

Request Body

customerId
string
required
Unique identifier for the customer that you can reference across the customer’s whole lifetime. Could be a database ID, random string, email or anything that uniquely identifies the customer.
email
string
Customer’s email address.
This is required if your account uses email-based channel merging.
mobile
string
Customer’s mobile number.
This is required if your account uses mobile-based channel merging.
lockReference
string
Reference ID for the locked coupon, if the coupon was previously locked.
pin
string
Pin code required for the coupon, if applicable.

Response

success
boolean
Whether the coupon was successfully burned/marked as used.
burnedAt
string
Timestamp when the coupon was burned.

Authorizations

apikey
string
header
required

Path Parameters

code
string
required

Body

application/json
customerId
string
required
email
string
mobile
string
lockReference
string
pin
string

Response

200 - application/json

Coupon burned successfully

success
boolean
burnedAt
string<date-time>