Get Transaction Details Loyalty
Action: POST
Endpoint: /api/CoreCredit/Rewards/GetTransactionDetailsLoyalty
The card issuer may utilize the GetTransactionDetailsLoyalty API to retrieve detailed lists of loyalty points against individual transactions posted on a card account. Loyalty transactions may be displayed within a specific period or for a specific statement period. Filter options allow retrieval of transactions based on categories such as earned, used, adjusted, forfeited, expired, reversal, collected, write-off, and abandoned reward points. The API fetches information including the merchant category, transaction date and time, loyalty program rule under which the loyalty points have been earned, type of reward (i.e., base, promotional, advance promotional),and the card acceptor's name and location.
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 |
AccountNumber string Conditional |
Account number of cardholder. Valid Values:0-9 Example:8000000000000037 Condition:At least one of AdminNumber/AccountNumber is required. Allowable Values: 19 |
AdminNumber int64 Conditional |
Details can be obtained by admin number (Embossing Account id) Valid Values:0-9 Example:82432455 Condition:At least one of AdminNumber/AccountNumber is required. |
InstitutionID integer Optional |
Unique identification number for Institution. Valid Values:0-9 Example:Fixed value needs to pass which is provided by Corecard. |
DetailActivityType string Optional |
Activity Type can be specified for specific transactions . Valid Values: Refer Appendix Section 5.55 (Activity Type) Example : 12 = Earned Allowable Values: 2 |
MerchantNumber integer Optional |
Unique Number which is assigned to a Merchant. Valid Values- 0-9 Format:XXXXXX Example:11642 |
FromDate datetime Optional |
Used as a criteria for Transaction Filter. Format: MM/DD/YYYY HH:MM:SS Example: 01/01/2020 11:05:05 |
ToDate datetime Optional |
Used as a criteria for Transaction Filter. Format: MM/DD/YYYY HH:MM:SS Example: 01/01/2020 11:05:05 |
StatementFrom datetime Optional |
Used as a criteria for Transaction Filter. Format: MM/DD/YYYY HH:MM:SS Example: 01/01/2020 11:05:05 |
StatementTo datetime Optional |
Used as a criteria for Transaction Filter. Format: MM/DD/YYYY HH:MM:SS Example: 01/01/2020 11:05:05 |
BatchSize integer Optional |
Number of Transaction which can be view in one Batch. Default Value would be 100 Valid Values: 0-9 Format: XX Example: 20 |
PageIndex integer Optional |
Number of page. Valid Values: 0 - 9 Format: XX Example: 12 |
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, "AccountNumber": "700000000785214", "AdminNumber": 100989, "InstitutionID": null, "DetailActivityType": "11", "MerchantNumber": null, "FromDate": null, "ToDate": null, "StatementFrom": null, "StatementTo": null, "BatchSize": null, "PageIndex": null }
Response fields details
Fields | Description |
---|---|
DetailsCount integer |
Number of Transactions. |
TransactionList array |
List of Transactions. |
ResponseID string |
This number will ensure that API hit our internal servers. Allowable Values: 20 |
AccountUUID string |
Basesegment's Universal Unique Id. Allowable Values: 20 |
AdminNumberUUID string |
EmbossingAccount's Universal Unique Id. Allowable Values: 20 |
Sample response body
{ "Message": "Loyalty Transaction details returned successfully.", "Status": true, "ErrorCode": "ERR01023", "ResponseData": { "DetailsCount": 10, "TransactionList": [ { "ReversalTarget": 14554444, "PromoPoints": 205.0, "LoyaltyExpirationDate": "11/02/2022 00:00:00", "TransactionPostTime": "11/02/2020 00:00:00", "DetailActivityType": "12", "TransactionDescription": "43801 = CASHBACK CREDIT", "LoyaltyPoints": 2055.2, "EquivalentAmount": 20.02, "EquivalentAmount_Web": null, "MerchantName": null, "StoreName": null, "RegisterName": null, "AccountNumber": "8110000000000448", "TransactionReference": "123372036855203839", "MerchantNameandLocation": null, "CardNumberLast4Digit": "4821", "TransactionSource": "4", "TransactionSourceDescription": "Generated", "PostDateTime": "11/02/2020 00:00:00", "MerchantCategory": "Restaurants", "MCCDescription": "Eating Places, Restaurants", "MCCCode": "5812", "RedemptionType": null, "PromoTxnAmount": 100.02, "LoyaltyProgramID": 10, "LoyaltyProgramName": "ABC Student Loan Rewards Loyalty Program", "BasePercent": 1.25, "PromoPercent": 1.55, "TotalPercent": 1.8, "RewardRedeemStatus": null, "ClientUniqueId": "3457577", "PartnerID": null, "ReasonCode": null, "RedeemBankAccountName": null, "TransactionID": 87874574, "RuleName": "Student Loan Base Reward Rule", "DebitCreditIndicator": -1 } ], "ResponseID": "56806584", "AccountUUID": "b58ce8d3-2bb1-492a-b224-af548236d843", "AdminNumberUUID": "97a5ca01-a0ce-4df1-9050-e5fa00c3b8ab" } }