Add Redemption Rule

Add Redemption Rule

Description¶

The addRedemptionRule endpoint is used to create a new Redemption rule within the Loyalty Rewards Program. This rule defines how users can redeem their accumulated loyalty points for rewards.

Request¶

Endpoint¶
/ui/v1/addRedemptionRule
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,
    "redemptionRuleStatus": {
        "name": "ACTIVE"
    },
    "redemptionCategory": {
        "name": "GIFT_CARDS"
    },
    "loyaltyTierLevel": {
        "name": "NONE"
    },
    "amountIssued": {
        "amount": "50.00",
        "currency": {
            "currencyCode": "USD"
        }
    },
    "createdUserId": "642",
    "maxRedeemablePointsRadioButton": "MAX_REDEEMABLE_POINTS_PER_TXN",
    "merchantId": "42",
    "description": "For each 10000 points you earn, you can redeem a $50.00 reward that can be applied to your next payment.",
    "numberOfPoints": "10000"
}

Response¶

{
    "id": 9,
    "createdDateTime": null,
    "lastUpdatedDateTime": null,
    "lockedDateTime": null,
    "lockedByUserId": null,
    "createdUserId": 642,
    "lastModifiedUserId": null,
    "numberOfPoints": 10000,
    "amountIssued": {
        "amount": 50.00,
        "currency": {
            "id": 1,
            "currencyCode": "USD",
            "currencyText": "United States Dollar",
            "currencySymbol": "$",
            "fractionalUnit": "Cent",
            "numOfDecimalPlaces": "2",
            "supportedByVisaCheckout": true,
            "createdDateTime": 1733858673000,
            "isoNumericCode": "840",
            "isoCountryCode": "840"
        }
    },
    "minimumRedeemablePoints": null,
    "maximumRedeemablePointsPerTxn": null,
    "maximumRedeemablePointsPerDay": null,
    "redemptionCategory": {
        "value": "Gift Cards",
        "name": "GIFT_CARDS"
    },
    "redemptionRuleStatus": {
        "value": "Active",
        "name": "ACTIVE"
    },
    "description": "For each 10000 points you earn, you can redeem a $50.00 reward that can be applied to your next payment.",
    "offsetRedeemablePoints": null,
    "loyaltyTierLevel": {
        "nickname": "None",
        "name": "NONE"
    },
    "merchantId": 42,
    "createdUserName": null,
    "message": {
        "code": "38",
        "type": {
            "name": "SUCCESS"
        },
        "include_i_icon": false,
        "description": "REDEMPTION_RULE_CREATION_SUCCESS",
        "parameters": null
    }
}

Updated As Of Version 6.6.x