Add Issuance Rule
Description¶
The addIssuanceRule
endpoint is used to create a new issuance rule within the Loyalty Rewards Program..
Request¶
Endpoint¶
/ui/v1/addIssuanceRule
Method¶
POST
Header¶
Content-Type: application/json
Authorization: $TOKEN
Note
Replace $TOKEN
in the request with the base64-encoded username/password combination in the format username:password
.
Given a username of username
and a password of password
, the request header would appear as follows:
Content-Type: application/json
Authorization: dXNlcm5hbWU6cGFzc3dvcmQ=
Request Body (Add)¶
{
"id": 0,
"issuanceRuleStatus": {
"name": "ACTIVE"
},
"loyaltyTierLevel": {
"name": "TIER1"
},
"pointsType": {
"name": "MULTIPLIER"
},
"sRuleValidFromDateTime": "2025-06-27",
"sRuleValidToDateTime": "2025-07-28",
"fromTime": "2025-06-27T04:00:00.000Z",
"toTime": "2025-06-29T03:59:00.000Z",
"pointsNeverExpireInd": true,
"pointsExpirationInMonths": "",
"fromAmount": {
"amount": "500.00",
"currency": {
"currencyCode": "USD"
}
},
"createdUserId": "340",
"bonusPointsRadioButton": "BONUS_POINTS_PER_OFFER",
"minimumAmountRequiredInd": false,
"offerRedemptionLimit": {
"name": "ONCE"
},
"merchantId": "1",
"offerDescription": "Earn 5X points when you book vacation packages, flights, hotels, and cars on ABCTravel.com.",
"multiplierPoints": "2",
"channel": {
"id": 1
},
"productId": 69,
"cardNetworkName": "VISA",
"quantityFrom": "1",
"quantityTo": "100",
"toAmount": {
"amount": "1000.00"
},
"bonusPointsPerOffer": "500"
}
Response¶
{
"id": 51,
"createdDateTime": null,
"lastUpdatedDateTime": null,
"lockedDateTime": null,
"lockedByUserId": null,
"createdUserId": 340,
"lastModifiedUserId": null,
"pointsType": {
"value": "Multiplier",
"name": "MULTIPLIER"
},
"multiplierPoints": 2,
"issuanceRuleStatus": {
"value": "Active",
"name": "ACTIVE"
},
"loyaltyTierLevel": {
"nickname": "Turquoise",
"name": "TIER1"
},
"flatPoints": null,
"bonusPointsPerOffer": 500,
"bonusPointsPerDay": null,
"productId": 69,
"quantityFrom": 1,
"quantityTo": 100,
"ruleValidFromDateTime": 1750996800000,
"ruleValidToDateTime": 1753761540000,
"pointsNeverExpireInd": true,
"pointsExpirationInMonths": null,
"channel": {
"id": 1,
"channelName": null,
"channelStatus": null,
"channelType": null,
"createdDateTime": null,
"merchantId": null,
"lockedDateTime": null,
"lockedByUserId": null,
"createdUserId": null,
"lastModifiedUserId": null,
"industryType": null,
"allowCashAsPaymentMethodInd": false,
"allowMoneyOrderAsPaymentMethodInd": false,
"allowPaperCheckAsPaymentMethodInd": false,
"allowEStoreCreditAsPaymentMethodInd": false,
"paymentMethods": [],
"allowDynamicRoutingCapabilityInd": false,
"secondaryPaymentGateway": null,
"tertiaryPaymentGateway": null,
"userCount": null,
"assignedPaymentMethods": null,
"message": null,
"paymentMethodsCount": null,
"merchantName": null
},
"offerDescription": "Earn 5X points when you book vacation packages, flights, hotels, and cars on ABCTravel.com.",
"minimumAmountRequiredInd": false,
"maximumDurationInMonths": null,
"offerRedemptionLimit": {
"value": "Once",
"name": "ONCE"
},
"cardNetworkName": "CARNET",
"merchantId": 1,
"fromAmount": {
"amount": 500,
"currency": {
"id": 1,
"currencyCode": "USD",
"currencyText": "United States Dollar",
"currencySymbol": "$",
"fractionalUnit": "Cent",
"numOfDecimalPlaces": "2",
"supportedByVisaCheckout": true,
"createdDateTime": 1608260908000,
"isoNumericCode": "840",
"isoCountryCode": "840"
}
},
"toAmount": {
"amount": 1000,
"currency": {
"id": 1,
"currencyCode": "USD",
"currencyText": "United States Dollar",
"currencySymbol": "$",
"fractionalUnit": "Cent",
"numOfDecimalPlaces": "2",
"supportedByVisaCheckout": true,
"createdDateTime": 1608260908000,
"isoNumericCode": "840",
"isoCountryCode": "840"
}
},
"minimumAmount": null,
"createdUserName": null,
"message": {
"code": "34",
"type": {
"name": "SUCCESS"
},
"include_i_icon": false,
"description": "ISSUANCE_RULE_CREATION_SUCCESS",
"parameters": null
},
"fromTime": 1750996800000,
"toTime": 1751169540000,
"sRuleValidFromDateTime": "2025-06-27",
"sRuleValidToDateTime": "2025-07-28"
}
Updated As Of Version 6.6.x