Get Redemption Rule

Description

The getRedemptionRule endpoint is used to retrieve the set of rules that govern how loyalty points are redeemed for a particular Redemption Rule within the system.

Request

Endpoint

/ui/v1/getRedemptionRule/{id}

Note

Replace id above with the internal ID of the Rule.

Method

GET

Content-Type: application/json
Authorization: Basic $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: Basic dXNlcm5hbWU6cGFzc3dvcmQ=

Response

{
    "id": 2,
    "createdDateTime": 1550083652000,
    "lastUpdatedDateTime": 1560958057000,
    "lockedDateTime": null,
    "lockedByUserId": null,
    "createdUserId": 1,
    "lastModifiedUserId": null,
    "numberOfPoints": 2,
    "amountIssued": {
        "amount": 0.010,
        "currency": {
            "id": 1,
            "currencyCode": "USD",
            "currencyText": "United States Dollar",
            "currencySymbol": "$",
            "fractionalUnit": "Cent",
            "numOfDecimalPlaces": "2",
            "supportedByVisaCheckout": true,
            "createdDateTime": 1733858673000,
            "isoNumericCode": "840",
            "isoCountryCode": "840"
        }
    },
    "minimumRedeemablePoints": 500,
    "maximumRedeemablePointsPerTxn": null,
    "maximumRedeemablePointsPerDay": null,
    "redemptionCategory": {
        "value": "Pay Balance",
        "name": "PAY_BALANCE"
    },
    "redemptionRuleStatus": {
        "value": "Active",
        "name": "ACTIVE"
    },
    "description": "For each 2000 points you earn, you can redeem a $10.00 reward that can be applied to your next payment.",
    "offsetRedeemablePoints": null,
    "loyaltyTierLevel": {
        "nickname": "None",
        "name": "NONE"
    },
    "merchantId": 1,
    "createdUserName": null,
    "message": null
}

Updated As Of Version: 6.6.x