Get Loyalty Program Segment
Action: POST
Endpoint: /api/CoreCredit/Rewards/GetLoyaltyProgramSegment
CoreCARD returns a loyalty program summary of reward points across different lifecycle buckets, in terms of credits, debits, adjustments, and redemptions. Use the GetLoyaltyProgramSegment API to retrieve details of reward points earned under a loyalty program with summaries, counts and amount of debits, credits, debit adjustment, credit adjustments, redemptions, and redemptions reversals in differing lifecycle buckets.
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/AccountHolder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Condition:At least one of AccountNumber/AdminNumber is required. Allowable Values: 19 |
|
AdminNumber int64 Conditional |
Details can be obtained by admin number (Embossing Acctid) Valid Values:0-9 Format:XXXXX Example:12345 Condition:At least one of AccountNumber/AdminNumber is required. |
|
LoyaltyProgramID integer Optional |
ID of Loyalty Program Valid Values:0-9 Format:XXXX Example:2345(Value shared by Corecard). |
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": "5000000000011071",
"AdminNumber": 59934,
"LoyaltyProgramID": 0
}
Response fields details
| Fields | Description |
|---|---|
|
LoyaltyProgramSegment array |
Array to show the details of rewards programwise. |
Sample response body
{
"Message": "Success.",
"Status": true,
"ErrorCode": "Err00017",
"ResponseData": {
"LoyaltyProgramSegment": [
{
"AccountNumber": "5000000000011071",
"MaskedCardNumber": "461668XXXXXX4612",
"LoyaltyProgramName": "abc Loyalty Program",
"CurrentBalance": 1087.84,
"FirstUsageBonus": 0.0,
"DayToDateBucket": {
"DebitsPoints": 0.0,
"DebitsCount": 0,
"CreditsPoints": 0.0,
"CreditsCount": 1,
"DebitAdjustmentsPoints": 0.0,
"DebitAdjustmentsCount": 0,
"CreditAdjustmentsPoints": 0.0,
"CreditAdjustmentsCount": 0,
"RedemptionsPoints": 0.0,
"RedemptionsCount": 0,
"RedemptionsReversalsPoints": 0.0,
"RedemptionsReversalsCount": 0
},
"CycleToDateBucket": {
"DebitsPoints": 60.46,
"DebitsCount": 1,
"CreditsPoints": 350.4,
"CreditsCount": 6,
"DebitAdjustmentsPoints": 0.0,
"DebitAdjustmentsCount": 0,
"CreditAdjustmentsPoints": 0.0,
"CreditAdjustmentsCount": 0,
"RedemptionsPoints": 0.0,
"RedemptionsCount": 0,
"RedemptionsReversalsPoints": 0.0,
"RedemptionsReversalsCount": 0
},
"MonthToDateBucket": {
"DebitsPoints": 60.46,
"DebitsCount": 1,
"CreditsPoints": 350.4,
"CreditsCount": 6,
"DebitAdjustmentsPoints": 0.0,
"DebitAdjustmentsCount": 0,
"CreditAdjustmentsPoints": 0.0,
"CreditAdjustmentsCount": 0,
"RedemptionsPoints": 0.0,
"RedemptionsCount": 0,
"RedemptionsReversalsPoints": 0.0,
"RedemptionsReversalsCount": 0
},
"YearToDateBucket": {
"DebitsPoints": 60.46,
"DebitsCount": 1,
"CreditsPoints": 350.4,
"CreditsCount": 6,
"DebitAdjustmentsPoints": 0.0,
"DebitAdjustmentsCount": 0,
"CreditAdjustmentsPoints": 350.4,
"CreditAdjustmentsCount": 0,
"RedemptionsPoints": 0.0,
"RedemptionsCount": 0,
"RedemptionsReversalsPoints": 0.0,
"RedemptionsReversalsCount": 0
},
"LifeToDateBucket": {
"DebitsPoints": 1219.17,
"DebitsCount": 3,
"CreditsPoints": 2307.01,
"CreditsCount": 16,
"DebitAdjustmentsPoints": 0.0,
"DebitAdjustmentsCount": 0,
"CreditAdjustmentsPoints": 350.4,
"CreditAdjustmentsCount": 0,
"RedemptionsPoints": 0.0,
"RedemptionsCount": 0,
"RedemptionsReversalsPoints": 0.0,
"RedemptionsReversalsCount": 0
}
}
]
}
}