cURL
Validate Single Coupon
Validate a single coupon and optionally lock it for exclusive use.
POST
cURL
This API validates a single coupon identified by
{code} and checks its eligibility for use by a customer. It also supports a locking feature, where setting the lock flag to True reserves the coupon by creating a lock reference. This ensures the coupon cannot be used by others during the lock session, preventing conflicts or double usage. By default, the lock flag is False, allowing only validation without reserving the coupon.
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.
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
The coupon code to validate.
Request Body
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.
Customer’s email address.
This is required if your account uses email-based channel merging.
Customer’s mobile number.
This is required if your account uses mobile-based channel merging.
Whether to lock the coupon for exclusive use. When set to
true, creates a lock reference to reserve the coupon.Pin code required for the coupon, if applicable.
Response
Whether the coupon is valid and can be used.
Reference ID for the locked coupon, if locking was requested.
The discount amount that will be applied.
Type of discount (fixed, percentage, shipping, etc.).