GetLoyaltyTransactionsProcessingParameters
Action: POST
Endpoint: /api/CoreCredit/ControlParameters/GetLoyaltyTransactionsProcessingParameters
This API is used to get the details of loyalty calculation parameters.
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 |
MonetaryTransactionCodeGroupID integer Mandatory |
Unique ID for Monetary transaction code group Valid Values: Fixed value provided by Corecard |
MonetaryTransactionCodeID integer Mandatory |
Code associated to uniquely identify the transaction. Valid Values:0-9 Example: 3742 =Purchase return reversal |
LoyaltyTransactionCodeGroupID integer Mandatory |
Code of the Loyalty Group which is having mapping of all the Loyalty transactions. Valid Values:Fixed value provided by CoreCard. Example:4563 |
LoyaltyTransactionCodeID integer Mandatory |
Unique ID of the loyalty transaction code. Valid Values: Fixed value provided by Corecard Format:XXXX Example: 3801 |
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, "MonetaryTransactionCodeGroupID": 6, "MonetaryTransactionCodeID": 10241, "LoyaltyTransactionCodeGroupID": 7, "LoyaltyTransactionCodeID": 10479 }
Response fields details
Fields | Description |
---|---|
LoyaltyTxnParameters
|
Group of Loyalty transactions parameters |
Sample response body
{ "Message": "Success", "Status": true, "ErrorCode": "Err00017", "ResponseData": { "LoyaltyTxnParameters": { "Amount": null, "Percent": 100.0, "RoundingUnit": 0.0, "CalculationMethod": "2", "LoyaltyTransactionCodeDesc": "602 = LOYALTY DEBIT", "LoyaltyTransactionCodeGroupDesc": "Loyalty MTC", "MonetaryTransactionCodeDesc": "6244 = PURCHASE REVERSAL INTERNATIONAL", "MonetaryTransactionCodeGroupDesc": "abc", "PointsPerUnit": null, "RoundingMethod": "0", "LoyaltyMerchantCategoryCodeList": [ { "MCCCategory": null, "MCCStatus": null, "CalculationMethod": null, "Amount": null, "Percent": null, "RoundingMethod": null, "RoundingUnit": null } ], "TransactionTiers": { "Tier1Amount": null, "Tier1Limit": null, "Tier2Amount": null, "Tier2Limit": null, "Tier3Amount": null, "Tier3Limit": null, "Tier4Amount": null, "Tier4Limit": null, "Tier5Amount": null, "Tier5Limit": null, "Tier6Amount": null, "Tier6Limit": null, "Tier7Amount": null, "Tier7Limit": null, "Tier8Amount": null, "Tier8Limit": null, "Tier9Amount": null, "Tier9Limit": null, "Tier10Amount": null, "Tier10Limit": null } } } }