Category links

API Links

Card Details

You can use CoreCard APIs (refer GetCardHolderDetail, GetCardDetails APIs) to get the details of cards like card information, expiry date, card type, etc. Using the API, you also can get the cardholder details like name, account number, address information, contact details, date of birth & all other details using the CoreCard API.

AdditionalCardDetail

Action: POST

Endpoint: /api/AdditionalCardDetail

POST /api/AdditionalCardDetail

Use this API to retrieve 'Card Activation-SelfService Validation Fields' set on product.

Request Fields Detail
Fields Description

APIVersion

string

Mandatory

Version of the API to be invoked Example: 1.3

Allowable Values:

10

IPAddress

string

Mandatory

IP Address of sender Example: 10.206.0.204

Allowable Values:

15

Source

string

Mandatory

Source from where API Call is initiated. CoreCard have multiple value of source for internal system (CoreMoney, SelfService, IVR, MobileSelfService) For external system expected source will be WEB.

Allowable Values:

50

CallerID

string

Optional

Caller Id of source from where API is initiated. It is End User phone number. Example: 7204454214 Condition - applicable in Case of IVR

Allowable Values:

20

CalledID

string

Optional

Called Id of destination for which API is initiated. It is Corecard IVR number. Example: 7314145404 Condition - applicable in Case of IVR

Allowable Values:

20

SessionID

string

Optional

Reserved for future use

Allowable Values:

50

ANI

string

Optional

Reserved for future use

Allowable Values:

0

DNS

string

Optional

Reserved for future use

Allowable Values:

0

Language

string

Optional

Flag to retrieve error message in specific language Example: 'en' for English

Allowable Values:

2

RequestDate

string

Optional

Request Date Time of API Format: MM-DD-YYYYTHH:MM:SS Example:- 11-12-2021T13:05:10

Allowable Values:

19

CardNumber

string

Conditional

Clear Card Number of the cardholder Valid values: 0-9 Example: 123456******0001 Condition: At least one of Card Number/Proxy Number is required.

Allowable Values:

16

ProxyNumber

string

Conditional

Proxy Number of the cardholder Valid values:0-9 Example:1005 Condition: At least one of Card Number/Proxy Number is required.

Allowable Values:

19

FlowSessionID

string

Optional

Reserved for future use
Sample Request Body 
{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "CardNumber": "",
  "ProxyNumber": "1312773"
}
Response Fields Detail
Fields Description

FlowSessionID

string

Reserved for future use

CardActivationValidation1

string

Returns the 'Card Activation-SelfService' parameters which is set as '1st Validation Field' on Product. Valid Values: Refer Appendix s section 'Card Activation Validation Parameter'. Example: 7 (Birth Date)

CardActivationValidation2

string

Returns the 'Card Activation-SelfService' parameters which is set as '2nd Validation Field' on Product. Valid Values: Refer Appendix s section 'Card Activation Validation Parameter'. Example: 7 (Birth Date)

CardActivationValidation3

string

Returns the 'Card Activation-SelfService' parameters which is set as '3rd Validation Field' on Product. Valid Values: Refer Appendix s section 'Card Activation Validation Parameter'. Example: 7 (Birth Date)

CardActivationValidation4

string

Returns the 'Card Activation-SelfService' parameters which is set as '4th Validation Field' on Product. Valid Values: Refer Appendix s section 'Card Activation Validation Parameter'. Example: 7 (Birth Date)

CardActivationValidation5

string

Returns the 'Card Activation-SelfService' parameters which is set as '5th Validation Field' on Product. Valid Values: Refer Appendix s section 'Card Activation Validation Parameter'. Example: 7 (Birth Date)

CardActivationValidation6

string

Returns the 'Card Activation-SelfService' parameters which is set as '6th Validation Field' on Product. Valid Values:1-23 Example:14 , New PIN

Sample Response Body 

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {
    "CardActivationValidation1": "7",
    "CardActivationValidation2": "11",
    "CardActivationValidation3": "6",
    "CardActivationValidation4": "",
    "CardActivationValidation5": "",
    "CardActivationValidation6": ""
  }
}

GetAdditionalCardDetails2

Action: POST

Endpoint: /api/GetAdditionalCardDetails2

POST /api/GetAdditionalCardDetails2

Use this API to retrieve the information of cards present on Account. Card issue date, expiry date, activation date along with name on card and card status can be retrieved by this api.

Request Fields Detail
Fields Description

APIVersion

string

Mandatory

Version of the API to be invoked Example: 1.3

Allowable Values:

10

IPAddress

string

Mandatory

IP Address of sender Example: 10.206.0.204

Allowable Values:

15

Source

string

Mandatory

Source from where API Call is initiated. CoreCard have multiple value of source for internal system (CoreMoney, SelfService, IVR, MobileSelfService) For external system expected source will be WEB.

Allowable Values:

50

CallerID

string

Optional

Caller Id of source from where API is initiated. It is End User phone number. Example: 7204454214 Condition - applicable in Case of IVR

Allowable Values:

20

CalledID

string

Optional

Called Id of destination for which API is initiated. It is Corecard IVR number. Example: 7314145404 Condition - applicable in Case of IVR

Allowable Values:

20

SessionID

string

Optional

Reserved for future use

Allowable Values:

50

ANI

string

Optional

Reserved for future use

Allowable Values:

0

DNS

string

Optional

Reserved for future use

Allowable Values:

0

Language

string

Optional

Flag to retrieve error message in specific language Example: 'en' for English

Allowable Values:

2

RequestDate

string

Optional

Request Date Time of API Format: MM-DD-YYYYTHH:MM:SS Example:- 11-12-2021T13:05:10

Allowable Values:

19

CardNumber

string

Conditional

Clear Card Number of the cardholder Valid values: 0-9 Example: 123456******0001 Condition:At least one of Card Number/Proxy Number/Account Number is required.

Allowable Values:

16

ProxyNumber

string

Conditional

Proxy Number of the cardholder Valid values:0-9 Example:1005 Condition:At least one of Card Number/Proxy Number/Account Number is required.

Allowable Values:

19

AccountNumber

string

Conditional

Account Number of the cardholder. Valid values: 0-9 Example: 2000000000000396893 Condition:At least one of Card Number/Proxy Number/Account Number is required.

Allowable Values:

19

DecisionFlag

Int32

Optional

This tag indicates the display of data in response on the basis of the flag value provided. Valid Values : 0 = Display card number and CVC in encrypted format. 1 = Display card number in decrypted format. 2 = Display CVC in decrypted format. 3 = Display card number and CVC in decrypted format. Note: Default value shall be 0 if not provided explicitly.
Sample Request Body 
{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "CardNumber": "",
  "ProxyNumber": "1310358",
  "AccountNumber": "",
  "DecisionFlag": 1
}
Response Fields Detail
Fields Description

AccountNumber

string

Account Number of the cardholder. Valid values: 0-9 Example: 2000000000000396893

EmbossingCount

string

Number of cards present on the account Example : 3

EmbossingDetails

array

Sample Response Body 

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {
    "AccountNumber": "",
    "EmbossingCount": "",
    "EmbossingDetails": [
      {
        "CardNumber": "4066846120001101",
        "ProxyNumber": "1310358",
        "AdminNumber": "1310358",
        "CardType": "0",
        "SecondaryCardType": "",
        "RequestedProxyNumber": "",
        "CardManualStatus": "Fraud",
        "FirstName": "k",
        "LastName": "Shrivastava",
        "ProductID": "1739",
        "AdditionalCardCount": 2,
        "AdditionalCardDetails": [
          {
            "CardSKEY": "1314591",
            "CardSequenceNumber": 1,
            "CardIssueDate": "2018-01-24T00:00:00",
            "IssueStatus": "Embossed",
            "CardStatus": "Closed",
            "CardActivationDate": "2019-12-28T00:00:00",
            "CVC": "694",
            "CardExpiryDate": "2028-12-01T00:00:00",
            "NameOnCard": "k a Shrivastava"
          },
          {
            "CardSKEY": "1317169",
            "CardSequenceNumber": 2,
            "CardIssueDate": "2018-12-01T00:00:00",
            "IssueStatus": "Embossed",
            "CardStatus": "Closed",
            "CardActivationDate": "2019-09-25T00:00:00",
            "CVC": "337",
            "CardExpiryDate": "2028-12-01T00:00:00",
            "NameOnCard": "k a Shrivastava"
          }
        ]
      }
    ]
  }
}

GetCardDetails

Action: POST

Endpoint: /api/GetCardDetails

POST /api/GetCardDetails

Use this API to get details of card which includes monetary details like Balance, Last load amount,outstanding authrization, Dispute amount and non monetary details like Account manual status,Branch name, OFAC score, card activation date.

Request Fields Detail
Fields Description

APIVersion

string

Mandatory

Version of the API to be invoked Example: 1.3

Allowable Values:

10

IPAddress

string

Mandatory

IP Address of sender Example: 10.206.0.204

Allowable Values:

15

Source

string

Mandatory

Source from where API Call is initiated. CoreCard have multiple value of source for internal system (CoreMoney, SelfService, IVR, MobileSelfService) For external system expected source will be WEB.

Allowable Values:

50

CallerID

string

Optional

Caller Id of source from where API is initiated. It is End User phone number. Example: 7204454214 Condition - applicable in Case of IVR

Allowable Values:

20

CalledID

string

Optional

Called Id of destination for which API is initiated. It is Corecard IVR number. Example: 7314145404 Condition - applicable in Case of IVR

Allowable Values:

20

SessionID

string

Optional

Reserved for future use

Allowable Values:

50

ANI

string

Optional

Reserved for future use

Allowable Values:

0

DNS

string

Optional

Reserved for future use

Allowable Values:

0

Language

string

Optional

Flag to retrieve error message in specific language Example: 'en' for English

Allowable Values:

2

RequestDate

string

Optional

Request Date Time of API Format: MM-DD-YYYYTHH:MM:SS Example:- 11-12-2021T13:05:10

Allowable Values:

19

CardNumber

string

Conditional

Clear Card Number of the cardholder Valid values: 0-9 Example: 123456******0001 Condition:At least one of Card Number/Proxy Number is required.

Allowable Values:

16

ProxyNumber

string

Conditional

Proxy Number of the cardholder Valid values:0-9 Example:1005 Condition:At least one of Card Number/Proxy Number is required.

Allowable Values:

19
Sample Request Body 
{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "CardNumber": "",
  "ProxyNumber": "1316728"
}
Response Fields Detail
Fields Description

Bsegment

Gets or sets Bsegment.

Embossing

Gets or sets Embossing Data.

UserInformation

Gets or sets User Information.

Customer

Gets or sets Customer Data.

Address

Gets or sets Address.

Logo

Gets or sets Logo.

AdditionalCard

Gets or sets Additional Card.

Sample Response Body 

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {
    "Bsegment": {
      "AccountNumber": "60000000032471",
      "CurrentBalance": 12.0,
      "OFACScore": "",
      "TotalOutStgAuthAmt": 23.0,
      "AvailableBalance": 12.0,
      "LastBulkOFACCheckDate": "2021-04-10T00:00:00",
      "LastTransactionDate": "2020-12-01T00:00:00",
      "OFACInquiryDate": "2020-03-01T00:00:00",
      "SavingAccountNumber": "",
      "SavingAccountCurrentBalance": 84.33,
      "OverDraftStatus": "No decision",
      "AllowedPINAccess": "",
      "CashAccessAllowed": "",
      "LexNexInquiryDate": "2020-12-06T00:00:00",
      "BranchID": 5737,
      "BranchName": "Convenient Card Top branch",
      "CardGeneratedStatus": "Active",
      "AccountManualStatus": "Active",
      "AccountGeneratedStatus": "Active",
      "ParentAccountNumber": "",
      "PurchaseAmountOfLastTransaction": 20.0,
      "DateOfLastLoad": "2020-12-01T00:00:00",
      "DisputeAmount": 23.41,
      "LastLoadAmount": 12.0,
      "OverDraftAmount": 75.12,
      "OFACMatchedBy": "Primary",
      "DirectDepositAdvanceAmount": 0.0
    },
    "Embossing": {
      "CardExpiryDate": "2026-12-01T00:00:00",
      "CardNumber4Digits": "",
      "PendingCardExpDate": "2031-04-01T00:00:00",
      "CardSequenceNumber": 1,
      "SecondaryCardType": "",
      "VirtualCardLimit": 110.0,
      "VirtualCardResetLimitAllowed": true,
      "VirtualCardResetAllowed": "1",
      "VirtualCardExpiryOption": "",
      "FraudSuspicious": 2,
      "CardHandoverDate": "2020-12-01T00:00:00",
      "EmbossCardStatus": "Active",
      "CardActivationDate": "2020-12-24T00:00:00",
      "PlasticCode": "59",
      "PlasticName": "Government Assistance Card - CN (59)",
      "DerivedStatus": "Active",
      "FailedLinkCardAttempts": 5,
      "LinkCardAttemptsProduct": 5,
      "InvalidActivationEnrollmentAttempts": 6,
      "InvalidAccessCodeAttempts": 4,
      "ProxyNumber": "1316728",
      "CardLockUnlockStatus": "0",
      "HoldEmbossing": 1
    },
    "UserInformation": {
      "UserId": "shailab_1212",
      "UserFirstName": "",
      "UserLastName": "",
      "LastLoginDate": "2020-12-01T00:00:00",
      "FailedAccessCodeChangeAttempts": 2,
      "LinkCardChecked_User": "1",
      "LinkCardChecked_Secondaycard_User": "1",
      "DelinkCardChecked_User": "1",
      "DelinkCardChecked_SecondaryCard_User": "1",
      "LinkCardChecked_Product": "1",
      "LinkCardChecked_SecondayCard_Product": "1",
      "DelinkCardChecked_Product": "1",
      "DelinkCardChecked_SecondaryCard_Product": "1"
    },
    "Customer": {
      "CustomerId": "1027161",
      "MaskedSocialSecurityNumber": "*****4343",
      "DateofBirth": "1994-01-28T00:00:00",
      "HomePhoneNumber": 3453453453,
      "WorkPhoneNumber": 0,
      "MobilePhoneNumber": 0,
      "EMailAddress1": "n@gmail.comm",
      "EMailAddress2": "",
      "OtherIdCountry": "",
      "OtherIDExpiryDate": "2026-04-15T00:00:00",
      "OtherIDIssueDate": "2031-08-25T00:00:00",
      "OtherIdState": "",
      "HomePhExtension": "91",
      "AlertEmailAddress": "example@gamil.com",
      "MemberId": "",
      "OFACInquiryDate": "2020-08-28T00:00:00",
      "OFACScore": "100.0",
      "SDNEntry1": "6365",
      "SDNEntry2": "6365",
      "SDNEntry3": "6365",
      "SDNEntry4": "11378",
      "SDNEntry5": "11378",
      "PreviousOFACScore": "0",
      "OFACClearanceDate": "2020-08-28T00:00:00"
    },
    "Address": {
      "Addressline1": "gateway",
      "Addressline2": "",
      "City": "Houston",
      "State": "TX",
      "Country": "US",
      "Postalcode": "45645"
    },
    "Logo": {
      "ProductName": "Convenient Visa Payroll Card",
      "FamilyCardAllow": "1"
    },
    "AdditionalCard": {
      "NameOnCard": "shailab gupta"
    }
  }
}