Get Reward Summary
Action: POST
Endpoint: /api/CoreCredit/Rewards/GetRewardSummary
Use this API to retrieve summarized details of rewards points that have accumulated, expired, or been forfeited for a card account. The API returns, among other information, the loyalty program name and ID; reward program start and end dates; reward points earned, expired, forfeited, and redeemed; the current reward points balance; and various reward bucket balances. Additionally, the API returns list of all such loyalty programs applicable on the card account.
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. |
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
}
Response fields details
| Fields | Description |
|---|---|
|
ListRewardsSummary array |
ListRewardsSummary |
|
LoyaltyProgramCount integer |
points detail count. |
Sample response body
{
"Message": "Loyalty points processed successfully.",
"Status": true,
"ErrorCode": "ERR01022",
"ResponseData": {
"ListRewardsSummary": [
{
"ListRewardYearWise": [
{
"Year": "2020",
"LoyaltyPointsEarned": 250.0,
"LoyaltyAmount": 100.0
}
],
"LoyaltyProgramID": 1,
"LoyaltyProgramName": "Card Loyalty Program",
"LoyaltyAmountEarned": 105.0,
"LoyaltyAmountRedeemed": 20.0,
"LoyaltyPointsExpired": 10.0,
"LoyaltyPointsForfeited": 30.0,
"LoyaltyPointsRecovered": 10.0,
"LoyaltyPointsAbandoned": 15.0,
"PendingRedeemPoints": 42.0,
"ApprovedRedeemPoints": 20.0,
"BeginningLoyaltyBalance": 100.0,
"RemainingLoyaltyBalance": 102.0
}
],
"LoyaltyProgramCount": 1
}
}