Update Buy, Gift & Transfer Rules

Description¶

The /updateBuyGiftTransferRule endpoint is used to update the Buy, Gift, and Transfer Rules associated with the Loyalty Rewards Program.

Request¶

Endpoint¶

/ui/v1//updateBuyGiftTransferRule

Method¶

POST

Header¶

Content-Type: application/json

Request Body¶

{
    "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.00",
        "currency": {
            "id": 1,
            "currencyCode": "USD",
            "currencyText": "United States Dollar",
            "currencySymbol": "$",
            "fractionalUnit": "Cent",
            "numOfDecimalPlaces": "2",
            "supportedByVisaCheckout": true,
            "createdDateTime": 1608260908000,
            "isoNumericCode": "840",
            "isoCountryCode": "840"
        }
    },
    "transferFeesPerPoint": {
        "amount": "0.50",
        "currency": {
            "id": 1,
            "currencyCode": "USD",
            "currencyText": "United States Dollar",
            "currencySymbol": "$",
            "fractionalUnit": "Cent",
            "numOfDecimalPlaces": "2",
            "supportedByVisaCheckout": true,
            "createdDateTime": 1608260908000,
            "isoNumericCode": "840",
            "isoCountryCode": "840"
        }
    },
    "maxTransferFees": {
        "amount": "1.00",
        "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,
    "transferFeesRadioButton": "TRANSFER_FEES_PER_POINT"
}

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,
        "currency": {
            "id": 1,
            "currencyCode": "USD",
            "currencyText": "United States Dollar",
            "currencySymbol": "$",
            "fractionalUnit": "Cent",
            "numOfDecimalPlaces": "2",
            "supportedByVisaCheckout": true,
            "createdDateTime": 1608260908000,
            "isoNumericCode": "840",
            "isoCountryCode": "840"
        }
    },
    "transferFeesPerPoint": {
        "amount": 0.5,
        "currency": {
            "id": 1,
            "currencyCode": "USD",
            "currencyText": "United States Dollar",
            "currencySymbol": "$",
            "fractionalUnit": "Cent",
            "numOfDecimalPlaces": "2",
            "supportedByVisaCheckout": true,
            "createdDateTime": 1608260908000,
            "isoNumericCode": "840",
            "isoCountryCode": "840"
        }
    },
    "maxTransferFees": {
        "amount": 1,
        "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": {
        "code": "53",
        "type": {
            "name": "SUCCESS"
        },
        "include_i_icon": false,
        "description": "BUY_GIFT_TRANSFER_RULE_MODIFICATION_SUCCESS",
        "parameters": null
    }
}

Updated As Of Version 6.6.x