GetLoyaltyProgram
Action: POST
Endpoint: /api/CoreCredit/ControlParameters/GetLoyaltyProgram
This API is to get the Loyalty Program details and its configurations for an Institution.
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 |
ProgramID integer Mandatory |
Unique ID of Program. Valid Values: 0-9 Format: XXX Example:123 |
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, "ProgramID": 21 }
Response fields details
Fields | Description |
---|---|
LoyaltyProgramDetails
|
Group Of Loyalty Program Details |
Sample response body
{ "Message": "Success", "Status": true, "ErrorCode": "Err00017", "ResponseData": { "LoyaltyProgramDetails": { "ProgramID": 21, "ProgramName": "AutoSecured Loyalty Program", "ProgramParentName": null, "ParentInstitution": "abc", "ProgramPriority": 0, "LoyaltyProgramProcessingParameters": { "ProgramStartDate": "05/26/2017 00:00:00", "ProgramEndDate": "10/20/2020 00:00:00", "ProgramRedemptionDate": null, "DisbursementCalculation": "1", "DisbursementFrequency": "17", "DisbursementMethod": "1", "DisbursementAmount": null, "MultipleDisbursement": "1", "DisbursementPercentage": 100.0, "DisbursementMinimum": "0", "BonusType": null, "BonusPeriod": null, "BonusAmount": null, "BonusPercentage": null, "MaximumCycleToDate": null, "MaximumMonthToDate": null, "MaximumYearToDate": null, "MaximumLifeToDate": null, "PrimaryCurrencyCode": "USD", "OneLoyaltyPointIsEqualTo": 0.01, "LoyaltyTransactionGroup": "84", "TransactionsGenerated": "0", "PromotionalReward": "None", "PromotionalRewardType": "By Reward Points", "GiftFilePrefix": null, "NegativePointAccumulation": "0", "LpExpirationMethod": null, "LPExpirationMonth": null, "MakeAccountInCreditOnRedeem": "NO", "IncludeBaseReward": "0" }, "LPContactInformation": { "LastName": null, "FirstName": null, "MiddleName": null, "AddressLine1": null, "AddressLine2": null, "City": null, "Province": null, "Country": null, "PostalCode": null, "TelephoneNumber": null, "FaxNumber": null, "EmailID": null }, "LPStateProvince": { "State1": null, "State2": null, "State3": null, "State4": null, "State5": null, "State6": null, "State7": null, "State8": null, "State9": null, "State10": null, "State11": null, "State12": null, "State13": null, "State14": null, "State15": null, "State16": null, "State17": null, "State18": null, "State19": null, "State20": null, "State21": null, "State22": null, "State23": null, "State24": null, "State25": null, "State26": null, "State27": null, "State28": null, "State29": null, "State30": null, "State31": null, "State32": null, "State33": null, "State34": null, "State35": null, "State36": null, "State37": null, "State38": null, "State39": null, "State40": null, "State41": null, "State42": null, "State43": null, "State44": null, "State45": null, "State46": null, "State47": null, "State48": null, "State49": null, "State50": null, "State51": null, "State52": null }, "LPSKUNumber": { "SKUNumbers1": null, "SKUNumbers2": null, "SKUNumbers3": null, "SKUNumbers4": null, "SKUNumbers5": null, "SKUNumbers6": null, "SKUNumbers7": null, "SKUNumbers8": null, "SKUNumbers9": null, "SKUNumbers10": null, "SKUNumbers11": null, "SKUNumbers12": null, "SKUNumbers13": null, "SKUNumbers14": null, "SKUNumbers15": null, "SKUNumbers16": null, "SKUNumbers17": null, "SKUNumbers18": null, "SKUNumbers19": null, "SKUNumbers20": null, "SKUNumbers21": null, "SKUNumbers22": null, "SKUNumbers23": null, "SKUNumbers24": null, "SKUNumbers25": null, "SKUNumbers26": null, "SKUNumbers27": null, "SKUNumbers28": null, "SKUNumbers29": null, "SKUNumbers30": null, "SKUNumbers31": null, "SKUNumbers32": null, "SKUNumbers33": null, "SKUNumbers34": null, "SKUNumbers35": null, "SKUNumbers36": null, "SKUNumbers37": null, "SKUNumbers38": null, "SKUNumbers39": null, "SKUNumbers40": null, "SKUNumbers41": null, "SKUNumbers42": null, "SKUNumbers43": null, "SKUNumbers44": null, "SKUNumbers45": null, "SKUNumbers46": null, "SKUNumbers47": null, "SKUNumbers48": null, "SKUNumbers49": null, "SKUNumbers50": null, "SKUNumbers51": null, "SKUNumbers52": null, "SKUNumbers53": null, "SKUNumbers54": null, "SKUNumbers55": null, "SKUNumbers56": null, "SKUNumbers57": null, "SKUNumbers58": null, "SKUNumbers59": null, "SKUNumbers60": null, "SKUNumbers61": null, "SKUNumbers62": null, "SKUNumbers63": null, "SKUNumbers64": null, "SKUNumbers65": null, "SKUNumbers66": null, "SKUNumbers67": null, "SKUNumbers68": null, "SKUNumbers69": null, "SKUNumbers70": null, "SKUNumbers71": null, "SKUNumbers72": null, "SKUNumbers73": null, "SKUNumbers74": null, "SKUNumbers75": null, "SKUNumbers76": null, "SKUNumbers77": null, "SKUNumbers78": null, "SKUNumbers79": null, "SKUNumbers80": null, "SKUNumbers81": null, "SKUNumbers82": null, "SKUNumbers83": null, "SKUNumbers84": null, "SKUNumbers85": null, "SKUNumbers86": null, "SKUNumbers87": null, "SKUNumbers88": null, "SKUNumbers89": null, "SKUNumbers90": null }, "LPMerchantCategoryCode": { "MCCFrom1": "3551", "MCCTo1": "3551", "MCCFrom2": "3555", "MCCTo2": "3555", "MCCFrom3": "3564", "MCCTo3": "3564", "MCCFrom4": "3582", "MCCTo4": "3582", "MCCFrom5": "1", "MCCTo5": "1", "MCCFrom6": "3624", "MCCTo6": "3624", "MCCFrom7": "3628", "MCCTo7": "3628", "MCCFrom8": "3662", "MCCTo8": "3662", "MCCFrom9": "3667", "MCCTo9": "3667", "MCCFrom10": "3669", "MCCTo10": "3669", "MCCFrom11": "3676", "MCCTo11": "3676", "MCCFrom12": "3679", "MCCTo12": "3679", "MCCFrom13": "3682", "MCCTo13": "3682", "MCCFrom14": "3708", "MCCTo14": "3708", "MCCFrom15": "3712", "MCCTo15": "3712", "MCCFrom16": "3728", "MCCTo16": "3728", "MCCFrom17": "3731", "MCCTo17": "3731", "MCCFrom18": "3737", "MCCTo18": "3738", "MCCFrom19": "3761", "MCCTo19": "3762", "MCCFrom20": "3764", "MCCTo20": "3764", "MCCFrom21": "3766", "MCCTo21": "3769", "MCCFrom22": "3771", "MCCTo22": "3771", "MCCFrom23": "1", "MCCTo23": "1", "MCCFrom24": "4829", "MCCTo24": "4829", "MCCFrom25": "1", "MCCTo25": "1", "MCCFrom26": "5962", "MCCTo26": "5962", "MCCFrom27": "6010", "MCCTo27": "6011", "MCCFrom28": "6050", "MCCTo28": "6051", "MCCFrom29": "6531", "MCCTo29": "6531", "MCCFrom30": "6534", "MCCTo30": "6534", "MCCFrom31": "7801", "MCCTo31": "7801", "MCCFrom32": "7993", "MCCTo32": "7995", "MCCFrom33": "9754", "MCCTo33": "9754", "MCCFrom34": "5933", "MCCTo34": "5933", "MCCFrom35": "9223", "MCCTo35": "9223", "MCCFrom36": "7995", "MCCTo36": "7995", "MCCFrom37": null, "MCCTo37": null, "MCCFrom38": null, "MCCTo38": null, "MCCFrom39": null, "MCCTo39": null, "MCCFrom40": null, "MCCTo40": null, "MCCFrom41": null, "MCCTo41": null, "MCCFrom42": null, "MCCTo42": null, "MCCFrom43": null, "MCCTo43": null, "MCCFrom44": null, "MCCTo44": null, "MCCFrom45": null, "MCCTo45": null, "MCCFrom46": null, "MCCTo46": null, "MCCFrom47": null, "MCCTo47": null, "MCCFrom48": null, "MCCTo48": null, "MCCFrom49": null, "MCCTo49": null, "MCCFrom50": null, "MCCTo50": null }, "LPProductCode": { "ProductCode1": null, "ProductCode2": null, "ProductCode3": null, "ProductCode4": null, "ProductCode5": null, "ProductCode6": null, "ProductCode7": null, "ProductCode8": null, "ProductCode9": null, "ProductCode10": null, "ProductCode11": null, "ProductCode12": null, "ProductCode13": null, "ProductCode14": null, "ProductCode15": null, "ProductCode16": null, "ProductCode17": null, "ProductCode18": null, "ProductCode19": null, "ProductCode20": null, "ProductCode21": null, "ProductCode22": null, "ProductCode23": null, "ProductCode24": null, "ProductCode25": null, "ProductCode26": null, "ProductCode27": null, "ProductCode28": null, "ProductCode29": null, "ProductCode30": null, "ProductCode31": null, "ProductCode32": null, "ProductCode33": null, "ProductCode34": null, "ProductCode35": null, "ProductCode36": null, "ProductCode37": null, "ProductCode38": null, "ProductCode39": null, "ProductCode40": null, "ProductCode41": null, "ProductCode42": null, "ProductCode43": null, "ProductCode44": null, "ProductCode45": null }, "LPProductCodeGroup": { "ProductCodeGroup1": null, "ProductCodeGroup2": null, "ProductCodeGroup3": null, "ProductCodeGroup4": null, "ProductCodeGroup5": null, "ProductCodeGroup6": null, "ProductCodeGroup7": null, "ProductCodeGroup8": null, "ProductCodeGroup9": null, "ProductCodeGroup10": null, "ProductCodeGroup11": null, "ProductCodeGroup12": null, "ProductCodeGroup13": null, "ProductCodeGroup14": null, "ProductCodeGroup15": null, "ProductCodeGroup16": null, "ProductCodeGroup17": null, "ProductCodeGroup18": null, "ProductCodeGroup19": null, "ProductCodeGroup20": null, "ProductCodeGroup21": null, "ProductCodeGroup22": null, "ProductCodeGroup23": null, "ProductCodeGroup24": null, "ProductCodeGroup25": null, "ProductCodeGroup26": null, "ProductCodeGroup27": null, "ProductCodeGroup28": null, "ProductCodeGroup29": null, "ProductCodeGroup30": null, "ProductCodeGroup31": null, "ProductCodeGroup32": null, "ProductCodeGroup33": null, "ProductCodeGroup34": null, "ProductCodeGroup35": null, "ProductCodeGroup36": null, "ProductCodeGroup37": null, "ProductCodeGroup38": null, "ProductCodeGroup39": null, "ProductCodeGroup40": null, "ProductCodeGroup41": null, "ProductCodeGroup42": null, "ProductCodeGroup43": null, "ProductCodeGroup44": null, "ProductCodeGroup45": null }, "LPBalances": { "CDDebitsAmount": 0.0, "CDDebitsCount": 0, "CDCreditsAmount": 0.0, "CDCreditsCount": null, "CDDebitAdjustmentsAmount": 0.0, "CDDebitAdjustmentsCount": 0, "CDCreditAdjustmentsAmount": 0.0, "CDCreditAdjustmentsCount": 0, "CDRedemptionsAmount": 0.0, "CDRedemptionsCount": 0, "CDRedemptionsReversalsAmount": 0.0, "CDRedemptionsReversalsCount": 0, "MTDDebitsAmount": 0.0, "MTDDebitsCount": 0, "MTDCreditsAmount": 0.0, "MTDCreditsCount": 0, "MTDDebitAdjustmentsAmount": 0.0, "MTDDebitAdjustmentsCount": 0, "MTDCreditAdjustmentsAmount": 0.0, "MTDCreditAdjustmentsCount": 0, "MTDRedemptionsAmount": 0.0, "MTDRedemptionsCount": 0, "MTDRedemptionsReversalsAmount": 0.0, "MTDRedemptionsReversalsCount": 0, "YTDDebitsAmount": 0.0, "YTDDebitsCount": 0, "YTDCreditsAmount": 0.0, "YTDCreditsCount": 0, "YTDDebitsAdjustmentsAmount": 0.0, "YTDDebitsAdjustmentsCount": 0, "YTDCreditAdjustmentsAmount": 0.0, "YTDCreditAdjustmentsCount": 0, "YTDRedemptionsAmount": 0.0, "YTDRedemptionsCount": 0, "YTDRedemptionsReversalsAmount": 0.0, "YTDRedemptionsReversalsCount": 0, "LTDDebitsAmount": 0.0, "LTDDebitsCount": 0, "LTDCreditsAmount": 0.0, "LTDCreditsCount": 0, "LTDDebitAdjustmentsAmount": 0.0, "LTDDebitAdjustmentsCount": 0, "LTDCreditAdjustmentsAmount": 0.0, "LTDCreditAdjustmentsCount": 0, "LTDRedemptionsAmount": 0.0, "LTDRedemptionsCount": 0, "LTDRedemptionsReversalsAmount": 0.0, "LTDRedemptionsReversalsCount": 0 } } } }