Get Card Details
Action: POST
Endpoint: /api/CoreCredit/CardManagement/GetCardDetails
Use this API to retrieve details of the card by providing the account\admin number and card sequence number in input. Details like card limit, expiry date, manual status, card type, etc. are returned.
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 Format: XXXXXXXXXXXXXXXX Example: 8000000000000037 Allowable Values: 19 |
|
AdminNumber int64 Conditional |
Admin number. Valid Values: 0-9 Example: 12345 Condition: Either of AdminNumber or AccountID is required. |
|
AccountID integer Conditional |
This tag reflects the Unique Identity of Account (CoreCard Bsegment Entitity, i.e., the Account ID of program card account). Valid Values: 0-9 Example: 12345 Condition: Either of AdminNumber or AccountID is required. |
|
CardSequenceNumber integer Optional |
This tag reflects the Sequence Number of the Card. Valid Values: 0-9 Example: 2 |
|
IdentifierToken string Conditional |
A generated token that is not expired can be used as an input field to access API. If we are passing this field in input, user should not pass any other account identifier. Condition:At least one account identifier is required. Allowable Values: 800 |
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": "9000000900001547",
"AdminNumber": 100720,
"AccountID": null,
"CardSequenceNumber": null,
"IdentifierToken": null
}
Response fields details
| Fields | Description |
|---|---|
|
EmbossingGroup
|
This is a group of Embossing related fields. |
Sample response body
{
"Message": "Success",
"Status": true,
"ErrorCode": "Err00017",
"ResponseData": {
"EmbossingGroup": {
"AdminNumber": 100720,
"CardExpirationDate": "01/2024",
"PendingCardExpirationDate": null,
"CardSequenceNumber": 1,
"VirtualCardLimit": 0.0,
"NewCardTransactionsSpendLimit": 0.0,
"VirtualCardAvailableLimit": 0.0,
"PINAttempts": 0,
"NameOnCard": "Alberta Charleson",
"IssueStatus": "Activated",
"CardType": "Primary Card",
"CardActivationDate": "03/20/2019 00:00:00",
"AccountNumber": "9000000900001547",
"CancellationStatus": null,
"DateIssued": null,
"CustomerType": "Individual",
"CardClosedDate": null,
"ReissueReportDate": null,
"PreissueReportDate": null,
"SSNLast4Digits": "9008",
"AssociatedAddress": "2992 Cameron Road, Malakoff, US 14236",
"DateOfBirth": "06/25/1984 00:00:00",
"HoldPlastic": null,
"DeliveryMechanism": "Standard",
"DeliveryDate": null,
"TotalOutStandingAmount": 0.0,
"TotalOutStandingCount": 0,
"CashOutStandingAmount": 0.0,
"CashOutStandingCount": 0,
"PurchaseOutStandingAmount": 0.0,
"PurchaseOutStandingCount": 0,
"ReturnOutStandingAmount": 0.0,
"ReturnOutStandingCount": 0,
"EmbossingManualStatus": 2,
"EmbossingManualStatusText": "Active",
"EmbossingGeneratedStatus": 2,
"EmbossingGeneratedStatusText": "Active",
"VirtualCardExpiryDate": null,
"VirtualCardExpiryOptions": null,
"VirtualCardLimitMethod": null,
"UsageRestriction": "0",
"CardActivationInvalidAttempts": 0,
"AvailableDeliveryMechanisms": [
{
"LutCode": "0",
"LutDescription": "Standard"
},
{
"LutCode": "1",
"LutDescription": "Priority"
},
{
"LutCode": "2",
"LutDescription": "Overnight"
}
],
"SameAsParentAddress": null,
"AllowReissueCancelledCard": false,
"UserID": "100720",
"AllowSecurityAnswerReset": 1,
"AllowPasswordReset": 1,
"TokenStatus": 1,
"CardImageID": "abc123",
"UniversalUniqueID": "df55eb4b-e2bd-42cf-8a91-c14f623a39c9",
"ActivationCode": "123456",
"AdditionalCardActivationCode": null,
"RegistrationStatus": null,
"UserStatus": 0,
"AllowResetVirtualCardLimit": false,
"NumberOfPINTry": 0,
"AllowedTxnsOnVirtualCard": 0,
"RemainingAllowedTxnOnVirtualCard": 0,
"AllowResetTxnOnVirtualCard": false,
"MaskedCardNumber": "525751XXXXXX9219",
"AllowResetPINAttempts": false,
"CustomerID": "76701",
"ManualCardStatus": "Active",
"LastStandInFileAction": "Add",
"StandInFilePurgeDate": "03/20/2019 00:00:00",
"AllowCashTransactions": false,
"UsageLimitResetFrequency": null
}
}
}