Skip to main content

Coupon Validation Endpoint

This endpoint validates coupons used with a specific POS transaction (applied to a purchase). POST /pos//coupon/validate/byTransaction

Input request

{
  "sessionId": "string",
  "campaignId": "string",
  "transactionId": "string",
  "couponUser": {
    "firstName": "string",
    "lastName": "string",
    "gender": "string",
    "phone": "string",
    "email": "string"
  }
}

Input parameters

Field nameDescription
sessionIdCoupon ID that needs to be validated.This parameter is used if we Validate a coupon that was issued to the Client (ID received from this enpoint: Get Customer Coupons)
campaignIdCoupon ID that needs to be validated.This parameter is used if we Validate a coupon that was Active on current Location (ID received from this enpoint: Get Active Coupons By Location)
transactionIdTransaction ID to which this coupon was applied
couponUserCustomer Data block
firstNameCustomer First name
lastNameCustomer Last name
genderCustomer gender
emailCustomer email
phoneCustomer phone

Response

{
  "posStatus": "Accepted",
  "data": {
    "externalSessionId": "string",
    "status": "string",
    "validationDate": "2025-07-28T16:52:54.696Z",
    "errorMessage": "string"
  }
}

Response parameters

Field nameDescription
posStatusOnly “Accepted” POS can validate a Coupon (POS must be registered with CMC in order to use this endpoint)
dataData Block
externalSessionIdCoupon ID that was validated (external or internal, depends on the Coupon provider)
statusOperation status
validationDateCoupon validation date
errorMessageError message