Update Issuance Rule Status

Description

The updateIssuanceRuleStatus endpoint is used to modify the activation status of an existing issuance rule in the Loyalty Rewards Program. This endpoint supports transitioning a rule from ACTIVE to DISABLED and vice versa.

Request

Endpoint

/ui/v1/updateIssuanceRuleStatus

Method

POST
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

{
    "id": 9,
    "createdDateTime": 1498841076000,
    "lastUpdatedDateTime": 1560956435000,
    "lockedDateTime": null,
    "lockedByUserId": null,
    "createdUserId": 1,
    "lastModifiedUserId": "340",
    "pointsType": {
        "value": "Flat",
        "name": "FLAT"
    },
    "multiplierPoints": null,
    "issuanceRuleStatus": {
        "value": "Active",
        "name": "DISABLED"
    },
    "loyaltyTierLevel": {
        "nickname": "None",
        "name": "NONE"
    },
    "flatPoints": 2000,
    "bonusPointsPerOffer": null,
    "bonusPointsPerDay": null,
    "productId": 3,
    "quantityFrom": null,
    "quantityTo": null,
    "ruleValidFromDateTime": 1498841076000,
    "ruleValidToDateTime": 1530377076000,
    "pointsNeverExpireInd": true,
    "pointsExpirationInMonths": 24,
    "channel": {
        "id": 1,
        "channelName": "Sandpiper Bay Channel",
        "channelStatus": {
            "name": "ACTIVE"
        },
        "channelType": {
            "name": "INTERNAL"
        },
        "createdDateTime": 1477321991000,
        "merchantId": 1,
        "lockedDateTime": null,
        "lockedByUserId": null,
        "createdUserId": 1,
        "lastModifiedUserId": 1,
        "industryType": {
            "name": "ECOMMERCE"
        },
        "allowCashAsPaymentMethodInd": false,
        "allowMoneyOrderAsPaymentMethodInd": false,
        "allowPaperCheckAsPaymentMethodInd": false,
        "allowEStoreCreditAsPaymentMethodInd": false,
        "paymentMethods": [
            {
                "id": 233,
                "paymentMethodType": {
                    "value": "Credit Card",
                    "name": "CREDIT_CARD"
                },
                "paymentGateway": {
                    "value": "Chase Paymentech (Orbital)",
                    "name": "CHASE_PAYMENTECH_ORBITAL"
                },
                "cardBrand": {
                    "value": "AMERICAN EXPRESS",
                    "name": "AMEX"
                },
                "cardId": 703,
                "createdUserId": 112,
                "lastModifiedUserId": 1,
                "createdDateTime": 1535409349000,
                "lastUpdatedDateTime": 1729832507000,
                "position": 13,
                "merchantId": 1
            },
            {
                "id": 2841,
                "paymentMethodType": {
                    "value": "eCheck (ACH)",
                    "name": "ECHECK"
                },
                "paymentGateway": {
                    "value": "Elavon (Converge & Commerce SDK)",
                    "name": "ELAVON_CONVERGE_COMMERCE_SDK"
                },
                "cardBrand": {
                    "value": "eCheck (ACH)",
                    "name": "ECHECK"
                },
                "cardId": null,
                "createdUserId": 340,
                "lastModifiedUserId": 1,
                "createdDateTime": 1709060747000,
                "lastUpdatedDateTime": 1729832507000,
                "position": 99,
                "merchantId": 1
            }
        ],
        "allowDynamicRoutingCapabilityInd": false,
        "secondaryPaymentGateway": {
            "value": "Chase Paymentech (NetConnect - Direct To Tandem)",
            "name": "CHASE_PAYMENTECH_NETCONNECT"
        },
        "tertiaryPaymentGateway": {
            "value": "Chase Paymentech (NetConnect - Direct To Tandem)",
            "name": "CHASE_PAYMENTECH_NETCONNECT"
        },
        "userCount": null,
        "assignedPaymentMethods": null,
        "message": null,
        "paymentMethodsCount": null,
        "merchantName": null
    },
    "offerDescription": "Earn 2000 points when you purchase your ticket with the Fly Delta app.",
    "minimumAmountRequiredInd": false,
    "maximumDurationInMonths": null,
    "offerRedemptionLimit": {
        "value": "No Limit",
        "name": "NO_LIMIT"
    },
    "cardNetworkName": null,
    "merchantId": 1,
    "fromAmount": {
        "amount": null,
        "currency": {
            "id": 1,
            "currencyCode": "USD",
            "currencyText": "United States Dollar",
            "currencySymbol": "$",
            "fractionalUnit": "Cent",
            "numOfDecimalPlaces": "2",
            "supportedByVisaCheckout": true,
            "createdDateTime": 1608260908000,
            "isoNumericCode": "840",
            "isoCountryCode": "840"
        }
    },
    "toAmount": {
        "amount": null,
        "currency": {
            "id": 1,
            "currencyCode": "USD",
            "currencyText": "United States Dollar",
            "currencySymbol": "$",
            "fractionalUnit": "Cent",
            "numOfDecimalPlaces": "2",
            "supportedByVisaCheckout": true,
            "createdDateTime": 1608260908000,
            "isoNumericCode": "840",
            "isoCountryCode": "840"
        }
    },
    "minimumAmount": {
        "amount": null,
        "currency": {
            "id": 1,
            "currencyCode": "USD",
            "currencyText": "United States Dollar",
            "currencySymbol": "$",
            "fractionalUnit": "Cent",
            "numOfDecimalPlaces": "2",
            "supportedByVisaCheckout": true,
            "createdDateTime": 1608260908000,
            "isoNumericCode": "840",
            "isoCountryCode": "840"
        }
    },
    "createdUserName": null,
    "message": null,
    "fromTime": null,
    "toTime": null,
    "sRuleValidFromDateTime": "30-06-2017 08:44 AM -08:00",
    "sRuleValidToDateTime": "30-06-2018 08:44 AM -08:00"
}

Response

{
    "id": 9,
    "createdDateTime": 1498841076000,
    "lastUpdatedDateTime": 1560956435000,
    "lockedDateTime": null,
    "lockedByUserId": null,
    "createdUserId": 1,
    "lastModifiedUserId": 340,
    "pointsType": {
        "value": "Flat",
        "name": "FLAT"
    },
    "multiplierPoints": null,
    "issuanceRuleStatus": {
        "value": "Disabled",
        "name": "DISABLED"
    },
    "loyaltyTierLevel": {
        "nickname": "None",
        "name": "NONE"
    },
    "flatPoints": 2000,
    "bonusPointsPerOffer": null,
    "bonusPointsPerDay": null,
    "productId": 3,
    "quantityFrom": null,
    "quantityTo": null,
    "ruleValidFromDateTime": 1498841076000,
    "ruleValidToDateTime": 1530377076000,
    "pointsNeverExpireInd": true,
    "pointsExpirationInMonths": 24,
    "channel": {
        "id": 1,
        "channelName": "Sandpiper Bay Channel",
        "channelStatus": {
            "name": "ACTIVE"
        },
        "channelType": {
            "name": "INTERNAL"
        },
        "createdDateTime": 1477321991000,
        "merchantId": 1,
        "lockedDateTime": null,
        "lockedByUserId": null,
        "createdUserId": 1,
        "lastModifiedUserId": 1,
        "industryType": {
            "name": "ECOMMERCE"
        },
        "allowCashAsPaymentMethodInd": false,
        "allowMoneyOrderAsPaymentMethodInd": false,
        "allowPaperCheckAsPaymentMethodInd": false,
        "allowEStoreCreditAsPaymentMethodInd": false,
        "paymentMethods": [
            {
                "id": 233,
                "paymentMethodType": {
                    "value": "Credit Card",
                    "name": "CREDIT_CARD"
                },
                "paymentGateway": {
                    "value": "Chase Paymentech (Orbital)",
                    "name": "CHASE_PAYMENTECH_ORBITAL"
                },
                "cardBrand": {
                    "value": "AMERICAN EXPRESS",
                    "name": "AMEX"
                },
                "cardId": 703,
                "createdUserId": 112,
                "lastModifiedUserId": 1,
                "createdDateTime": 1535409349000,
                "lastUpdatedDateTime": 1729832507000,
                "position": 13,
                "merchantId": 1
            },
            {
                "id": 2841,
                "paymentMethodType": {
                    "value": "eCheck (ACH)",
                    "name": "ECHECK"
                },
                "paymentGateway": {
                    "value": "Elavon (Converge & Commerce SDK)",
                    "name": "ELAVON_CONVERGE_COMMERCE_SDK"
                },
                "cardBrand": {
                    "value": "eCheck (ACH)",
                    "name": "ECHECK"
                },
                "cardId": null,
                "createdUserId": 340,
                "lastModifiedUserId": 1,
                "createdDateTime": 1709060747000,
                "lastUpdatedDateTime": 1729832507000,
                "position": 99,
                "merchantId": 1
            }
        ],
        "allowDynamicRoutingCapabilityInd": false,
        "secondaryPaymentGateway": {
            "value": "Chase Paymentech (NetConnect - Direct To Tandem)",
            "name": "CHASE_PAYMENTECH_NETCONNECT"
        },
        "tertiaryPaymentGateway": {
            "value": "Chase Paymentech (NetConnect - Direct To Tandem)",
            "name": "CHASE_PAYMENTECH_NETCONNECT"
        },
        "userCount": null,
        "assignedPaymentMethods": null,
        "message": null,
        "paymentMethodsCount": null,
        "merchantName": null
    },
    "offerDescription": "Earn 2000 points when you purchase your ticket with the Fly Delta app.",
    "minimumAmountRequiredInd": false,
    "maximumDurationInMonths": null,
    "offerRedemptionLimit": {
        "value": "No Limit",
        "name": "NO_LIMIT"
    },
    "cardNetworkName": null,
    "merchantId": 1,
    "fromAmount": {
        "amount": null,
        "currency": {
            "id": 1,
            "currencyCode": "USD",
            "currencyText": "United States Dollar",
            "currencySymbol": "$",
            "fractionalUnit": "Cent",
            "numOfDecimalPlaces": "2",
            "supportedByVisaCheckout": true,
            "createdDateTime": 1608260908000,
            "isoNumericCode": "840",
            "isoCountryCode": "840"
        }
    },
    "toAmount": {
        "amount": null,
        "currency": {
            "id": 1,
            "currencyCode": "USD",
            "currencyText": "United States Dollar",
            "currencySymbol": "$",
            "fractionalUnit": "Cent",
            "numOfDecimalPlaces": "2",
            "supportedByVisaCheckout": true,
            "createdDateTime": 1608260908000,
            "isoNumericCode": "840",
            "isoCountryCode": "840"
        }
    },
    "minimumAmount": {
        "amount": null,
        "currency": {
            "id": 1,
            "currencyCode": "USD",
            "currencyText": "United States Dollar",
            "currencySymbol": "$",
            "fractionalUnit": "Cent",
            "numOfDecimalPlaces": "2",
            "supportedByVisaCheckout": true,
            "createdDateTime": 1608260908000,
            "isoNumericCode": "840",
            "isoCountryCode": "840"
        }
    },
    "createdUserName": null,
    "message": {
        "code": "37",
        "type": {
            "name": "SUCCESS"
        },
        "include_i_icon": false,
        "description": "ISSUANCE_RULE_DISABLE_SUCCESS",
        "parameters": null
    },
    "fromTime": null,
    "toTime": null,
    "sRuleValidFromDateTime": null,
    "sRuleValidToDateTime": null
}

Updated As Of Version 6.6.x