Category links

API Links

GetLoyaltyRuleDetails

Action: POST

Endpoint: /api/CoreCredit/ControlParameters/GetLoyaltyRuleDetails

This API is used to Get Details of Loyalty Rule via RuleID. Note: Rule ID can be Retreived using the 'SearchLoyaltyRuleDetails' API.

Request fields details
Fields Description

Source

string

Mandatory

Source of API Consumer For external system expected sources will be WEB.

Allowable Values:

50

IPAddress

string

Optional

IP Address of Client / Application Hosting Server Example: 10.206.0.204

Allowable Values:

15

DateFormat

string

Optional

Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS

Allowable Values:

25

CurrencyCode

string

Optional

Currency Code Place Holder for Future Use. Valid Values: Refer Appendix Section - Currency Code Example:840 = US Dollar Condition:If no value is passed, default value = 840

Allowable Values:

10

CurrencySymbolType

string

Optional

Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD

Allowable Values:

10

Language

string

Optional

Place Holder for Future Use. Language: en: means use English Default: en - English

Allowable Values:

10

ExternalIP

string

Mandatory

IP Address of end user of API

Allowable Values:

50

SessionID

string

Optional

Session identifier of the API Example: 000028;026;1349906692

Allowable Values:

100

APIVersion

string

Mandatory

Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0

Allowable Values:

10

CallerID

string

Optional

Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR)

Allowable Values:

20

CalledID

string

Optional

Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR)

Allowable Values:

20

RequestTime

datetime

Optional

Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23

RuleID

integer

Mandatory

ID of Loyalty Rule. Valid Values: 0-9(Value provided by Corecard) Format: XXXX Example:1234

Sample request body
{
  "Source": "Web",
  "IPAddress": "10.120.0.1",
  "DateFormat": null,
  "CurrencyCode": null,
  "CurrencySymbolType": null,
  "Language": null,
  "ExternalIP": "10.120.0.0",
  "SessionID": null,
  "APIVersion": "2.0",
  "CallerID": null,
  "CalledID": null,
  "RequestTime": null,
  "RuleID": 1
}
Response fields details
Fields Description

LoyaltyRule

LoyaltyRule

DynamicQualificationLogicList

array

DynamicQualificationLogic list, will be populated only if Rule Type is Advance Promotional.

IndividualQualificationSetupList

array

IndividualQualificationSetup list, will be populated only if Rule Type is Advance Promotional

MerchantGroupList

array

MerchantGroup list Condition: This block is applicable only when Rule Setup On = [Merchant ID Group] OR [All/Multiple].

AcquiringInstitutionIdGroupList

array

AcquiringInstitutionIdGroup list Condition: This block is applicable only when Rule Setup On = [AcqInstIdGrp] OR [All/Multiple]

MerchantCategoryList

array

MerchantCategoryList Condition: This block is applicable only when Rule Setup On = [Merchant Category] OR [All/Multiple].

MCCList

array

MCC List Condition: This block is applicable only when Rule Setup On = [MCC] OR [All/Multiple]

SkuGroupList

array

SKU Group List Condition: This block is applicable only when Rule Setup On = [SKU] OR [All/Multiple]

EntryModeList

array

EntryModeList Condition: This block is applicable only when Rule Setup On = [Entry Mode] OR [All/Multiple]

ProductCodeList

array

Product Code List Condition: This block is applicable only when Rule Setup On = [Product Code] OR [All/Multiple]

ProductCodeGroupList

array

Product Code Group List Condition: This block is applicable only when Rule Setup On = [Product Code Group] OR [All/Multiple]

StateProvienceList

array

State/Province List Condition: This block is applicable only when Rule Setup On = [State/Province] OR [All/Multiple]

CardPresentIndicatorList

array

CardPresentIndicatorList Condition: This block is applicable only when Rule Setup On = [Card Present/Not Present] OR [All/Multiple]

Sample response body

{
  "Message": "Success.",
  "Status": true,
  "ErrorCode": "Err00017",
  "ResponseData": {
    "LoyaltyRule": {
      "RuleID": 79,
      "RuleName": "ruletest",
      "RuleType": 3,
      "RuleTypeDesc": "Advance Promotional",
      "RuleDescription": "test rule",
      "RuleDetailDescription": "test",
      "RuleApplication": 1,
      "RuleApplicationDesc": "Purchase",
      "RuleSetUpOn": 10,
      "RuleSetUpOnDesc": "All",
      "RuleStatus": 0,
      "RuleStatusDesc": "Active",
      "RuleCalculationMethod": 1,
      "CalculationBase": 2,
      "CalculationAmountPoints": 100.0,
      "CalculationPercent": null,
      "RoundingMethod": 0,
      "RoundingUnit": null,
      "MerchantGroupInEx": null,
      "MccCategoryInEx": null,
      "MccCodeInEx": null,
      "EntryModeInEx": null,
      "StateProvinceInEx": null,
      "ProductCodeGroupInEx": null,
      "ProductCodeInEx": null,
      "CardIndicatorInEx": null,
      "NonMonetaryInEx": null,
      "MerchantNameInEx": null,
      "AcquiringInstitutionIdGroupInEx": null,
      "SkuGroupInEx": null,
      "PurchaseHistoryFound": 1,
      "XMonths": 6,
      "TotalSpendThresholdAmount": 10.0,
      "TotalPercentCap": 10.0,
      "RecurringReward": null,
      "RecurringRewardApplicableAfter": null,
      "RecurringRewardApplicableFrom": null,
      "ThresholdSpendCTD": 10.0,
      "MaxLoyaltyAmountEarningLimit": 10.0,
      "TransactionSizeThresholdAmount": 10.0,
      "TransactionCountThreshold": 10,
      "RewardNextToXTransactions": 10,
      "RewardApplicableFrom": 3,
      "RewardApplicableTo": 5,
      "ApplicableToXPeriod": 1,
      "TransactiontocheckforThreshold": 2,
      "MinimumCalculation": "1",
      "OneTimeReward": 1,
      "CalculatedRewardsOnOldTransactionsCount": 1,
      "CalculatedRewardsOnOldTransactionsSpend": 0,
      "NumberofConsecutiveGoodPayments": 1,
      "ChecktopSpending": 1,
      "RuleTypeInAlert": 3,
      "RuleReQualification": 1,
      "DisbursementPeriod": null
    },
    "DynamicQualificationLogicList": null,
    "IndividualQualificationSetupList": [
      {
        "ParameterName": "4 = MID Group",
        "OperatorConditon": "=",
        "AmountOrCount": null,
        "LogicalOperator": "AND",
        "AddtionalLogicalOperator": "AND",
        "MIDGroup": null,
        "MccCategory": null,
        "MCC": null,
        "PurchaseMethod": null
      }
    ],
    "MerchantGroupList": null,
    "AcquiringInstitutionIdGroupList": null,
    "MerchantCategoryList": null,
    "MCCList": null,
    "SkuGroupList": null,
    "EntryModeList": null,
    "ProductCodeList": null,
    "ProductCodeGroupList": null,
    "StateProvienceList": null,
    "CardPresentIndicatorList": null,
    "NonMonetaryActivityList": null,
    "MerchantList": null,
    "TierBasedQualificationSetupList": null
  }
}