Card Life Cycle Change Log
Action: POST
Endpoint: /api/CoreCredit/CardManagement/CardLifeCycleChangeLog
Use this API to obtain a card's life cycle changes to the issue status, shipping status, or manual card status. The API can also retrieve information for a specific card life cycle event (e.g., specific manual card status for the provided admin number). Additionally, the API returns the old and new values and other information, such as change date and time. If no change entity is provided, the API will display an all status change log.
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 Mandatory |
Details can be obtained by admin number (Embossing Acctid) Valid Values:0-9 Format:XXXXX Example:12345 |
ChangeEntity string Optional |
Card Status entity based specific details can be obtain by ChangeEntity Possible Values: IssueStatus, ShippingStatus, ManualCardStatus If no value mentioned above specified, it will show all Status change log Format: XXXXXXXXX Example: IssueStatus 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, "AdminNumber": 129308, "ChangeEntity": "" }
Response fields details
Fields | Description |
---|---|
CardType string |
Specifies if its primary card or secondary card. Valid Values: 0,1 Format: X Example:0 – Primary Card, 1 – Secondary Card Allowable Values: 50 |
CardLifeCycleDetails array |
array CardLifeCycleDetails |
Sample response body
{ "Message": "Success.", "Status": true, "ErrorCode": "Err00017", "ResponseData": { "CardType": "Primary Card", "CardLifeCycleDetails": [ { "ChangeEntity": "IssueStatus", "ChangeDateTime": "01/15/2017 13:06:22", "OldValue": "NULL", "NewValue": "2" } ] } }