Parameter | Description | Data type |
---|---|---|
TenderValue | Value of the price reeduction given as means of payment. | Number |
RebateValue | Value of the price reduction. | Number |
DateTimeUTC | UTC time of the validation. | String |
UserReference | Unique identifier of the user. | String |
TransRef | Unique Id of the transaction. | String |
StoreRef | Unique Id of the store in which the validation has been made. | String |
ScheduleId | Unique Id of the schedule linked to the campaign. | Integer |
POSRef | Unique Id of the POS. | String |
Customer | Unique Id for the customer owner of the campaign. | Integer |
CampaignId | Unique Id for the campaign. One campaign can be linked to several schedules. | Integer |
ValueCode | Unique coupon code that has been validated. | String |
TotalValue | The total value of the complete receipt where this coupon was used. | Number |
MerchantRemuneration | The monetary value that the merchant should be compensated per coupon redemption. | Number |
ExternalRef | Reference received from third party when coupons have been issued using Coupon API - Issue request or if content has been sent manually. | String |
ValidationCount | Number of times a coupon has been validated. | Integer |
StoreName | Name of the store in which the validation has been made. | String |
ScheduleDescription | Name of the schedule. | String |
ScheduleOwner | Name of the customer that created the schedule. | String |
CampaignName | Name of the campaign. | String |
DateTime | Local time of the validation. | String |
MediaType | Indicates whether the coupon was issued on App, SMS or as a Codes campaign. | String |
OperatorRef | Id of the cashier that served this customer. | String |
ExtParam | For customers with Promotion ID based POS integration, this contains the POS settings of the campaign, eg. a Promotion ID and/or Tender ID | String |
Country | Customer's country of operation. | String |
HandlingFee | A secondary monetary value that the merchant should be compensated per coupon redemption. | Number |