Get Promotional Reward Details
Action: POST
Endpoint: /api/CoreCredit/Rewards/GetPromotionalRewardDetails
This API returns the list of promotional rewards plans applied to an account within the provided date range. Each promotional reward plan also includes the details of transactions that were qualified under the promotional plan. Transaction details include transaction date, amount, reward point, reward amount, and others.
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 |
|
AdminNumber int64 Conditional |
Details can be obtained by admin number (Embossing Acctid). Valid Values: 0-9 Format:XXXXXX Example:123654 Condition:At least one of AdminNumber/AccountNumber is required. |
|
AccountNumber string Conditional |
Account Number of Cardholder. Valid Values: 0-9 Format: XXXXXXXXXXXXXXXX Example: 8000000000000037 Condition:At least one of AdminNumber/AccountNumber is required. Allowable Values: 19 |
|
StartDate datetime Optional |
It reflect the starting date of promotional plan. Format: MM/DD/YYYY HH:MM:SS Example: 01/01/2020 11:05:05 |
|
EndDate datetime Optional |
It reflect the date on which promotional rate ends. Format: MM/DD/YYYY HH:MM:SS Example: 01/02/2020 11:05:05 |
Sample request body
{
"Source": "Web",
"IPAddress": "10.120.0.0",
"DateFormat": null,
"CurrencyCode": null,
"CurrencySymbolType": null,
"Language": null,
"ExternalIP": "10.120.0.0",
"SessionID": null,
"APIVersion": "2.0",
"CallerID": null,
"CalledID": null,
"RequestTime": null,
"AdminNumber": 1478255,
"AccountNumber": null,
"StartDate": null,
"EndDate": null
}
Response fields details
| Fields | Description |
|---|---|
|
RuleDetails array |
Array to return promo details basis promotional offer applicable on the Account. |
Sample response body
{
"Message": "Success",
"Status": true,
"ErrorCode": "Err00017",
"ResponseData": {
"RuleDetails": [
{
"RuleID": 54,
"RuleName": "5% on Starbucks or Dunkin up to $20_Ignite",
"OfferPeriod": "03/01/2016-03/31/2016",
"RewardAmount": 3.47,
"RewardPoints": 347.0,
"TransactionInformation": [
{
"TransactionID": "1478555555",
"TransactionPostDate": "03/31/2016 00:00:00",
"TransmissionDateTime": "03/31/2016 00:00:00",
"TransactionAmount": 2.6,
"RewardAmount": 0.13,
"RewardPoints": 13.0
}
]
}
]
}
}