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 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 |
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 Optional |
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 Optional |
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 Optional |
Method by which loyalty points will be redeemed for the Account. Valid Values : 1 = ACH 3 = Statement Credit 5 = Partner Pay 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: 1800 |
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 details
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
{ "Message": "Loyalty points processed successfully.", "Status": true, "ErrorCode": "ERR01022", "ResponseData": { "ResponseID": "154545" } }