Buy, Gift & Transfer Rules

Description

The getBuyGiftTransferRule endpoint is used to retrieve the Buy, Gift, and Transfer Rules associated with the Loyalty Rewards Program from the database. This endpoint provides detailed configuration information that governs how loyalty points can be purchased (Buy), given to others (Gift), or moved between accounts (Transfer).

Request

Endpoint

/ui/v1/getBuyGiftTransferRule/{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": 1,
    "createdDateTime": 1498062258000,
    "lastUpdatedDateTime": 1560956435000,
    "lockedDateTime": null,
    "lockedByUserId": null,
    "createdUserId": 1,
    "lastModifiedUserId": 340,
    "maxPurchasePointsForSelfPerYear": 10000,
    "maxPurchasePointsForOthersPerYear": 100000,
    "minimumTransferPoints": 500,
    "maxTransferPointsPerYear": 55000,
    "flatTransferFees": {
        "amount": 15.000,
        "currency": {
            "id": 1,
            "currencyCode": "USD",
            "currencyText": "United States Dollar",
            "currencySymbol": "$",
            "fractionalUnit": "Cent",
            "numOfDecimalPlaces": "2",
            "supportedByVisaCheckout": true,
            "createdDateTime": 1608260908000,
            "isoNumericCode": "840",
            "isoCountryCode": "840"
        }
    },
    "transferFeesPerPoint": {
        "amount": 1.000,
        "currency": {
            "id": 1,
            "currencyCode": "USD",
            "currencyText": "United States Dollar",
            "currencySymbol": "$",
            "fractionalUnit": "Cent",
            "numOfDecimalPlaces": "2",
            "supportedByVisaCheckout": true,
            "createdDateTime": 1608260908000,
            "isoNumericCode": "840",
            "isoCountryCode": "840"
        }
    },
    "maxTransferFees": {
        "amount": null,
        "currency": {
            "id": 1,
            "currencyCode": "USD",
            "currencyText": "United States Dollar",
            "currencySymbol": "$",
            "fractionalUnit": "Cent",
            "numOfDecimalPlaces": "2",
            "supportedByVisaCheckout": true,
            "createdDateTime": 1608260908000,
            "isoNumericCode": "840",
            "isoCountryCode": "840"
        }
    },
    "ruleStatus": {
        "value": "Active",
        "name": "ACTIVE"
    },
    "payFeeWithPoints": 4000,
    "maxReceivablePointsPerYear": 47000,
    "merchantId": 1,
    "createdUserName": null,
    "message": null
}

Updated As Of Version: 6.6.x