Loyalty Redemption Rules

Description

The loyaltyRedemptionRules endpoint is used to retrieve the set of various Redemption Rules of the Loyalty Rewards Program that exists within the System.

Request

Endpoint

/ui/v1/loyaltyRedemptionRules

Method

POST
Content-Type: application/json

Response

{
    "records": [
        {
            "id": 1,
            "createdDateTime": 1550083652000,
            "lastUpdatedDateTime": 1560958057000,
            "lockedDateTime": null,
            "lockedByUserId": null,
            "createdUserId": 1,
            "lastModifiedUserId": 1,
            "numberOfPoints": 1,
            "amountIssued": {
                "amount": 0.01,
                "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": "Default",
                "name": "DEFAULT"
            },
            "redemptionRuleStatus": {
                "value": "Active",
                "name": "ACTIVE"
            },
            "description": "For each 1000 points you earn, you can redeem a $10.00 reward that can be applied to your next purchase. Points may be redeemed once you reach the minimum point value i.e., 500 Points.",
            "offsetRedeemablePoints": null,
            "loyaltyTierLevel": {
                "nickname": "None",
                "name": "NONE"
            },
            "merchantId": 1,
            "createdUserName": null,
            "message": null
        },
        {
            "id": 2,
            "createdDateTime": 1550083652000,
            "lastUpdatedDateTime": 1560958057000,
            "lockedDateTime": null,
            "lockedByUserId": null,
            "createdUserId": 1,
            "lastModifiedUserId": null,
            "numberOfPoints": 2,
            "amountIssued": {
                "amount": 0.01,
                "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
        },
        {
            "id": 3,
            "createdDateTime": 1550083652000,
            "lastUpdatedDateTime": 1560958057000,
            "lockedDateTime": null,
            "lockedByUserId": null,
            "createdUserId": 1,
            "lastModifiedUserId": null,
            "numberOfPoints": 2,
            "amountIssued": {
                "amount": 0.01,
                "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": "Gift Cards",
                "name": "GIFT_CARDS"
            },
            "redemptionRuleStatus": {
                "value": "Active",
                "name": "ACTIVE"
            },
            "description": "VELA allows a maximum of 150,000 points for trade, exchange, and redemption transactions including redemptions for gift cards per year. For each 2000 points you earn, you can redeem a $10.00 reward that can be applied towards your Gift Card purchase.",
            "offsetRedeemablePoints": null,
            "loyaltyTierLevel": {
                "nickname": "None",
                "name": "NONE"
            },
            "merchantId": 1,
            "createdUserName": null,
            "message": null
        },
        {
            "id": 4,
            "createdDateTime": 1550083652000,
            "lastUpdatedDateTime": 1560958057000,
            "lockedDateTime": null,
            "lockedByUserId": null,
            "createdUserId": 1,
            "lastModifiedUserId": null,
            "numberOfPoints": 1,
            "amountIssued": {
                "amount": 0.01,
                "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": "Donate To Charity",
                "name": "DONATE_TO_CHARITY"
            },
            "redemptionRuleStatus": {
                "value": "Active",
                "name": "ACTIVE"
            },
            "description": "The charity you choose would get 1 cent per point for the maximum points of 500,000 you donate in a calendar year.",
            "offsetRedeemablePoints": null,
            "loyaltyTierLevel": {
                "nickname": "None",
                "name": "NONE"
            },
            "merchantId": 1,
            "createdUserName": null,
            "message": null
        },
        {
            "id": 5,
            "createdDateTime": 1550083652000,
            "lastUpdatedDateTime": 1560958057000,
            "lockedDateTime": null,
            "lockedByUserId": null,
            "createdUserId": 1,
            "lastModifiedUserId": null,
            "numberOfPoints": 10,
            "amountIssued": {
                "amount": 0.25,
                "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": "Buy/Gift Points",
                "name": "BUY_GIFT_POINTS"
            },
            "redemptionRuleStatus": {
                "value": "Active",
                "name": "ACTIVE"
            },
            "description": "With VELA rewards program you can buy yourself extra points, or give them as a gift, to help get to rewards options faster. You can purchase Points at a rate of 2.5 cents each in 1,000 point increments, so you can get 1,000 points for $25.00",
            "offsetRedeemablePoints": null,
            "loyaltyTierLevel": {
                "nickname": "None",
                "name": "NONE"
            },
            "merchantId": 1,
            "createdUserName": null,
            "message": null
        },
        {
            "id": 6,
            "createdDateTime": 1550083652000,
            "lastUpdatedDateTime": 1560958057000,
            "lockedDateTime": null,
            "lockedByUserId": null,
            "createdUserId": 1,
            "lastModifiedUserId": null,
            "numberOfPoints": 100,
            "amountIssued": {
                "amount": 0.05,
                "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": "Transfer Points",
                "name": "TRANSFER_POINTS"
            },
            "redemptionRuleStatus": {
                "value": "Active",
                "name": "ACTIVE"
            },
            "description": "For each point that you transfer into a partner airline, a fee of $0.0005 per point will be charged to your account.",
            "offsetRedeemablePoints": null,
            "loyaltyTierLevel": {
                "nickname": "None",
                "name": "NONE"
            },
            "merchantId": 1,
            "createdUserName": null,
            "message": null
        },
        {
            "id": 7,
            "createdDateTime": 1550083652000,
            "lastUpdatedDateTime": 1560958057000,
            "lockedDateTime": null,
            "lockedByUserId": null,
            "createdUserId": 1,
            "lastModifiedUserId": null,
            "numberOfPoints": 100,
            "amountIssued": {
                "amount": 1.25,
                "currency": {
                    "id": 1,
                    "currencyCode": "USD",
                    "currencyText": "United States Dollar",
                    "currencySymbol": "$",
                    "fractionalUnit": "Cent",
                    "numOfDecimalPlaces": "2",
                    "supportedByVisaCheckout": true,
                    "createdDateTime": 1733858673000,
                    "isoNumericCode": "840",
                    "isoCountryCode": "840"
                }
            },
            "minimumRedeemablePoints": 1000,
            "maximumRedeemablePointsPerTxn": null,
            "maximumRedeemablePointsPerDay": null,
            "redemptionCategory": {
                "value": "Default",
                "name": "DEFAULT"
            },
            "redemptionRuleStatus": {
                "value": "Active",
                "name": "ACTIVE"
            },
            "description": "As a Platinum member, you’ll earn 25% more value than a regular member when you redeem. For example, 50,000 points are worth $625 towards purchases or payments.",
            "offsetRedeemablePoints": null,
            "loyaltyTierLevel": {
                "nickname": "Gold",
                "name": "TIER3"
            },
            "merchantId": 1,
            "createdUserName": null,
            "message": null
        },
        {
            "id": 8,
            "createdDateTime": 1642191448000,
            "lastUpdatedDateTime": null,
            "lockedDateTime": null,
            "lockedByUserId": null,
            "createdUserId": 404,
            "lastModifiedUserId": 411,
            "numberOfPoints": 1,
            "amountIssued": {
                "amount": 1,
                "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": "Default",
                "name": "DEFAULT"
            },
            "redemptionRuleStatus": {
                "value": "Active",
                "name": "ACTIVE"
            },
            "description": null,
            "offsetRedeemablePoints": null,
            "loyaltyTierLevel": {
                "nickname": "None",
                "name": "NONE"
            },
            "merchantId": 1,
            "createdUserName": null,
            "message": null
        }
    ],
    "recordCount": null,
    "message": null
}

Updated As Of Version 6.6.x