Get Loyalty Accumulated Points
Action: POST
Endpoint: /api/CoreCredit/Rewards/GetLoyaltyAccumulatePts
Use this API to retrieve the summary of accumulated rewards points. The API fetches the list of applicable loyalty programs on a card account and related reward points information within that program. It shows the loyalty program start and end dates, points earned, the equivalent dollar amounts of the points, expired loyalty points, forfeited loyalty points, and other information.
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 |
CardNumber string Conditional |
This tag reflect the card number Valid Values: 0-9 Format: XXXXXXXXXXXXXXXX Example: 1236547896541236 Condition: At least one of Card Number\Admin Number\Account Number\Account id is required. Allowable Values: 16 |
AccountNumber string Conditional |
This tag reflects the account number Valid Values: 0-9 Format: XXXXXXXXXXXXXXXX Example: 8000000000000037 Condition: At least one of Card Number\Admin Number\Account Number\Account id is required. Allowable Values: 19 |
AdminNumber int64 Conditional |
This Tag reflects the Admin number Valid Values: 0-9 Format: XXXXX Example: 12345 Condition: At least one of Card Number\Admin Number\Account Number\Account id is required. |
AccountID integer Conditional |
Account ID represents Unique Identity of Account (CoreCard Bsegment Entitity, i.e., the Account ID of program card account). Format: XXXXX Example: 12345 Condition: At least one of Card Number\Admin Number\Account Number\Account id is required. |
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, "CardNumber": "", "AccountNumber": "0000000000503918", "AdminNumber": null, "AccountID": 167473 }
Response fields details
Fields | Description |
---|---|
LoyaltyAccumulatePointsList array |
Array of Loyalty Accumulate Points |
Sample response body
{ "Message": "Success", "Status": true, "ErrorCode": "Err00017", "ResponseData": { "LoyaltyAccumulatePointsList": [ { "LoyaltyProgram": 3, "LoyaltyProgramName": "Davidson", "ProgramStartDate": "04/02/2008 00:00:00", "ProgramEndDate": "12/31/2099 00:00:00", "LoyaltyPoints": 4420.0, "LoyaltyAmount": 44.2, "LoyaltyPointsExpired": 0.0, "LoyaltyPointsForfeited": 0.0, "PromoRewardCTD": 0.0, "AmtQualifiedForPromoRewardCTD": 0.0, "PendingRedeemPoints": 0.0, "TotalRedeemPointsLTD": 0.0, "TotalRedeemAmountLTD": 0.0 } ] } }