Reward Transactions
When financial transactions are received and reward points calculated, the CoreCard system posts reward transactions at the card account level. These posts include details such as financial transactions against which reward points are earned, the equivalent monetary value of calculated reward points, and reward point expiration dates.
Loyalty Points Management
Action: POST
Endpoint: /api/CoreCredit/Rewards/LoyaltyPointsManagement
Use this API to manually redeem reward points available on a card account. There are three ways to redeem the rewards points: ACH, statement credit, and partner pay. The API returns the remaining available reward points after a redemption and the status of the manual redemption.
Request fields detail
Fields | Description |
---|---|
Source string |
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 |
Place Holder for Future Use. Currency Code Ex. 840 = US Doller. 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 |
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 |
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 |
Card holder's Account Number. 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. |
DecisionFlag string Mandatory |
To decide if Loyatly points needs to Add or Remove Valid Values: 0 = Add Loyalty Points 1 = Reduce Loyalty Points 2 = Redeem Loyalty Points Allowable Values: 2 |
LoyaltyProgramID integer Mandatory |
ID of Loyalty Program Valid Values:0-9 Format:XXXX Example:2345(Value shared by Corecard). |
ValueofLoyaltyPoint decimal Mandatory |
The value of loyalty points to Add/Reduce/Redeem for the Account. Valid Values:0-9 Example:150.50 |
BankAccountNumber string Conditional |
This tag reflect the Bank account number of payment bank. Valid Values:0-9 Example:123654214556 Allowable Values: 19 |
RedemptionMethod string Mandatory |
Method by which loyalty points will be redeemed for the Account. Valid Values : 1 = Manual 2 = Automatic 3 = As per Loyalty Program Setup Example:1 Allowable Values: 2 |
LoanPayDown string Optional |
Flag to decide if Loyalty Points should use for Load Payment or not. Valid Values:0-No and 1-Yes Example : 1 Allowable Values: 2 |
Notes string Optional |
The note capture by the user. Valid Values:A-Z,0-9 Example : This is a test note Allowable Values: 50 |
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, "DecisionFlag": null, "LoyaltyProgramID": null, "ValueofLoyaltyPoint": null, "BankAccountNumber": null, "RedemptionMethod": null, "LoanPayDown": null, "Notes": null }
Response fields detail
Fields | Description |
---|---|
ResponseID string |
This number indicates that API responded. Response ID is unique. This value will be null if no authentication information was passed. Response ID can be used for tracking. Example:7485122 |
Sample response body
{ "application/json": { "Message": "Loyalty points processed successfully.", "Status": true, "ErrorCode": "ERR01022", "ResponseData": { "ResponseID": "154545" } } }
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 detail
Fields | Description |
---|---|
Source string |
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 |
Place Holder for Future Use. Currency Code Ex. 840 = US Doller. 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 |
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 |
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 detail
Fields | Description |
---|---|
LoyaltyProgramSegment array |
Array to show the details of rewards programwise. |
Sample response body
{ "application/json": { "Message": "Success.", "Status": true, "ErrorCode": "Err00017", "ResponseData": { "LoyaltyProgramSegment": [ { "AccountNumber": "5000000000011071", "MaskedCardNumber": "461668XXXXXX4612", "LoyaltyProgramName": "Final 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 } } ] } } }
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 detail
Fields | Description |
---|---|
Source string |
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 |
Place Holder for Future Use. Currency Code Ex. 840 = US Doller. 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 |
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 |
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 detail
Fields | Description |
---|---|
LoyaltyAccumulatePointsList array |
Array of Loyalty Accumulate Points |
Sample response body
{ "application/json": { "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 } ] } } }
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 detail
Fields | Description |
---|---|
Source string |
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 |
Place Holder for Future Use. Currency Code Ex. 840 = US Doller. 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 |
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 |
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 . Example : 11 = All,12 = Earned ,13 = Used,14 = Reversal Allowable Values: 2 |
MerchantNumber integer Optional |
Merchant Number. |
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 |
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 }
Response fields detail
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
{ "application/json": { "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, "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": "SM 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" } ], "ResponseID": "56806584", "AccountUUID": "b58ce8d3-2bb1-492a-b224-af548236d843", "AdminNumberUUID": "97a5ca01-a0ce-4df1-9050-e5fa00c3b8ab" } } }