Get Issuance Rule

Description¶

The getIssuanceRule endpoint is used to retrieve the set of rules that govern how loyalty points are issued for a particular Issuance Rule within the system.

Request¶

Endpoint¶

/ui/v1/getIssuanceRule/{id}

Method¶

GET

Header¶

Content-Type: application/json
Authorization: Basic $TOKEN

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": 23,
    "createdDateTime": 1540220833000,
    "lastUpdatedDateTime": 1560956435000,
    "lockedDateTime": null,
    "lockedByUserId": null,
    "createdUserId": 1,
    "lastModifiedUserId": 307,
    "pointsType": {
        "value": "Multiplier",
        "name": "MULTIPLIER"
    },
    "multiplierPoints": 5,
    "issuanceRuleStatus": {
        "value": "Active",
        "name": "ACTIVE"
    },
    "loyaltyTierLevel": {
        "nickname": "None",
        "name": "NONE"
    },
    "flatPoints": null,
    "bonusPointsPerOffer": null,
    "bonusPointsPerDay": null,
    "productId": 6,
    "quantityFrom": null,
    "quantityTo": null,
    "ruleValidFromDateTime": 1540180800000,
    "ruleValidToDateTime": 1540353540000,
    "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 5X points when you book vacation packages, flights, hotels, and cars on RenniesTravel.com.",
    "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": 1540180800000,
    "toTime": 1540353540000,
    "sRuleValidFromDateTime": "2018-10-22",
    "sRuleValidToDateTime": "2018-10-23"
}

Updated As Of Version: 6.6.x