Category links

API Links

Card Management

When a card is issued to an account holder there are various operations that can be performed on an account as well as on the card. Using CoreCard APIs, you can perform various activities linked to a card created under an account, i.e., activating the card, registering the card for online payments, defining spend limit, blocking the card, reissuing or replacing the card in case of lost/stolen/damage, apply for a status, retrieve card and account holder’s data.

You can instruct to hold physical card printing using the CoreCard API, i.e. only the virtual card number will be generated, and a physical plastic card will not be issued against the account.

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": ""
  }
}

CardActivation

Action: POST

Endpoint: /api/CardActivation

POST /api/CardActivation

Use this API to activate card by providing correct data in card validation parameter set on program.

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

UniqueID

string

Optional

Reserved for future use

Allowable Values:

19

UniqueIDFlag

string

Optional

Reserved for future use

Allowable Values:

1

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

FirstName

string

Conditional

Cardholder First Name Valid Values: A-Z, a-z Example: Andrew Condition: This is required if validation parameter set on product as part of Full Name

Allowable Values:

40

MiddleName

string

Optional

Cardholder Middle Name Valid values are A-Z, a-z, 0-9 Example: Charles Condition: This is required if validation parameter set on product as part of Full Name

Allowable Values:

40

LastName

string

Conditional

Cardholder Last Name Valid values:A-Z, a-z Example: Hudson Condition: This is required if validation parameter set on product as part of Full Name

Allowable Values:

40

AddressLine1

string

Conditional

Address Line 1 of the Cardholder Valid values : A-Z, a-z, 0-9 Example: 15 Penang Street Point Condition : This is required if validation parameter set on product as Full Address. Both AddressLine1 and AddressLine2 is Mandatory.

Allowable Values:

40

AddressLine2

string

Conditional

Address Line 2 of the Cardholder Valid values: A-Z, a-z, 0-9 Example: 1 mecca way Condition : This is required if validation parameter set on product as Full Address. Both AddressLine1 and AddressLine2 is Mandatory.

Allowable Values:

40

EmailAddress1

string

Conditional

E Mail Address 1 of Cardholder Valid Values: A-Z, a-z, 0-9 @ . Example: sem_pp1@gmail.com Condition : This is required if validation parameter set on product as EMail One

Allowable Values:

100

DateOfBirth

string

Conditional

Date of Birth of cardholder Format: MM/DD/YYYY Valid Values: 0-9 Example:- 03/26/1986 Condition : This is required if validation parameter set on product as Birth Date

Allowable Values:

10

LanguageIndicator

string

Conditional

Language Indicator Valid Values:A-Z,a-z. Example: en, where en represents 'English' Condition : This is required if validation parameter set on product as Language Indicator

Allowable Values:

5

PostalCode

string

Conditional

Cardholder Postal Code of Residence Valid Values:A-Z,a-z,0-9 Example: 30093 Condition : This is required if validation parameter set on product as Postal Code

Allowable Values:

10

HomePhoneNumber

string

Conditional

Home Phone Number. Valid Values: 0-9 Example: 9812338769 Condition : This is required if validation parameter set on product as Home Phone

Allowable Values:

19

WorkPhoneNumber

string

Conditional

Cardholder Work Phone Number Valid values:0-9 Example:9632581470 Condition : This is required if validation parameter set on product as Work Phone

Allowable Values:

19

SocialSecurityNumber

string

Conditional

Social Security Number of Cardholder Valid Values:0-9 Example:123456789 Condition :This is required if validation parameter set on product as Social Security Number of Cardholder.

Allowable Values:

9

CardExpiryDate

string

Conditional

Expiration Date of the card. Format is (MMYYYY). Valid Values: 0-9 Example : 092020 Condition : This is required if validation parameter set on product as Card Expiration Date

Allowable Values:

6

CurrentPIN

string

Conditional

Current Card PIN of four digits. Valid Values: 0-9 Example: 1346 Condition : This is required if validation parameter set on product as Current PIN

Allowable Values:

4

CurrentPassword

string

Conditional

Current Password of Cardholder. Valid Values: A-Z, a-z,0-9, Special characters. Example: Test123! Condition : This is required if validation parameter set on product as Current Password

Allowable Values:

9

NewPIN

string

Conditional

Four Digit New PIN of the card Valid Values: 0-9 Example:1346 Condition : This is required if validation parameter set on product as New PIN

Allowable Values:

4

NewPassword

string

Conditional

New Password of Cardholder. Valid Values: A-Z, a-z,0-9, Special characters. Example: Test123! Condition : This is required if validation parameter set on product as New Password

Allowable Values:

9

IDNumber

string

Conditional

Last 4 Digits of Primary ID Valid Values: 0-9 Example: 4586 Condition : This is required if validation parameter set on product as Last 4 Digits of Primary ID

Allowable Values:

25

CVV2

string

Conditional

Three digit printed on the back of the card. Valid Values - 0-9 Example: 213 Condition : This is required if validation parameter set on product as CVC2

Allowable Values:

4

BirthYear

string

Conditional

Birth Year Of CardHolder Valid Values: 0-9 Example:1994 Condition : This is required if validation parameter set on product as Birth Year

Allowable Values:

4

CustomAccountID

string

Conditional

Any custom ID which is used to uniquely identify the Account. Valid values: A-Z, a-z, 0-9 Example:123456789 Condition: This is required if validation parameter set on product as Custom Account ID

Allowable Values:

25

SSNLast4Digits

string

Conditional

Last 4 digits of Social Security Number of a Cardholder Valid values :0-9 Example: 6789 Condition : This is required if validation parameter set on product as Last 4 Digits of SSN

Allowable Values:

4

CIPCollectSSN

string

Conditional

Social Security Number of a Cardholder Valid values :0-9 Example: 123456788 Condition : This tag is required if validation parameter set on product as CIPCollectSSN

CIPCollectIDType

string

Conditional

Type of ID. Valid Values: 0-12 Example 05 Appendix Section: ID Name Values Condition : This tag is required if validation parameter set on product as CIPCollectIDType

CIPCollectIDNumber

string

Conditional

ID Number. Valid Values: A-Z, a-z, 0-9 Example: NT1234569PM Condition : This tag is required if validation parameter set on product as CIPCollectIDNumber

CollectIDCountry

string

Conditional

Country of Identification proof. Valid Values:a-z, 0-9 Example: US Refer Appendix section : Country Code Values Condition : This tag is required if validation parameter set on product as CollectIDCountry

CollectIDDate

string

Conditional

ID Issue Date Format: MM/DD/YYYY Example : 09/16/2022 Condition : This tag is required if validation parameter set on product as CollectIDDate

Allowable Values:

10

CollectIDExpirationDate

string

Conditional

Expiration date of ID. Format: MM/DD/YYYY Valid Values:0-9 Example:03/26/1998 Condition : This tag is required if validation parameter set on product as CollectIDExpirationDate

Allowable Values:

10

CollectIDState

string

Conditional

ID Issue State Valid Values:A-Z,a-z Example:GA Appendix Section: State Codes (US) Condition : This tag is required if validation parameter set on product as CollectIDState

Allowable Values:

10

SACValue

string

Conditional

Used to hold SAC Value passed by user in input. Condition: It will be asked as per product set up

Allowable Values:

14

Sample Request Body
{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "CardNumber": "4066836120006077",
  "ProxyNumber": "",
  "FirstName": "Mark",
  "MiddleName": "",
  "LastName": "smith",
  "AddressLine1": "AB",
  "AddressLine2": "CD",
  "EmailAddress1": "",
  "DateOfBirth": "03/26/1986",
  "LanguageIndicator": "",
  "PostalCode": "",
  "HomePhoneNumber": "",
  "WorkPhoneNumber": "",
  "SocialSecurityNumber": "458968579",
  "CardExpiryDate": "",
  "CurrentPIN": "6077",
  "CurrentPassword": "",
  "NewPIN": "0143",
  "NewPassword": "",
  "IDNumber": "",
  "CVV2": "",
  "BirthYear": "",
  "CustomAccountID": "",
  "SSNLast4Digits": "1234",
  "CIPCollectSSN": "",
  "CIPCollectIDType": "",
  "CIPCollectIDNumber": "",
  "CollectIDCountry": "",
  "CollectIDDate": "",
  "CollectIDExpirationDate": "12/24/2024",
  "CollectIDState": "",
  "SACValue": ""
}
Response Fields Detail
Fields Description

CardRegistered

string

Display whether card is registered or not. Valid Values: 0 = Card not registered in Self Service 1 = Card registered in Self Service Example: 0

CardLinked

string

Display whether card is linked with any self service user or not. Valid Values: 0 = Card not Linked with any Self Service User 1 = Card Linked with Self Service User Example: 0

FlowSessionID

string

Reserved for future use

Sample Response Body

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {
    "CardRegistered": "0",
    "CardLinked": ""
  }
}

CardLockUnlockRequest

Action: POST

Endpoint: /api/CardLockUnlockRequest

POST /api/CardLockUnlockRequest

Use this API to temporarily Lock/Unlock a card for usage. When a card is in locked status, then all scheme debit transactions will be restricted on the card.

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

CardLockUnlockStatus

string

Mandatory

Flag to set card lock unlock status. Valid values : 0: Card Unlocked 1: Card Locked Example: 1

Allowable Values:

1

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

Sample Response Body

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {}
}

ChangeCardStatus

Action: POST

Endpoint: /api/ChangeCardStatus

POST /api/ChangeCardStatus

Use this API to update card manual status. Status which needs to be applied on card is provided in Card Status ID API object. Valid values of card statuses are Active, Inactive, Blocked, Lost, Stolen and Closed.

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

CardStatusID

string

Mandatory

New Card status value which is to be updated. Valid values:0 to 5. Example: To set status as closed, provide value '5' in this tag. Refer Appendix section : Card Status Values

Allowable Values:

1

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

Sample Response Body

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {}
}

DecryptAccountData

Action: POST

Endpoint: /api/DecryptAccountData

POST /api/DecryptAccountData

Use this API to decrypt either card number or SSN or both or card number along with CVV based on decision flag.

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

AccountNumber

string

Conditional

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

Allowable Values:

19

ProxyNumber

string

Conditional

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

Allowable Values:

19

DecisionFlag

Int32

Mandatory

Used for performing various operations when respective flag values defined below are passed. Valid values are : 0 = To Show Full CardNumber. 1 = To Show Full SSN. 2 = To Show Full CardNumber and SSN. 3 = To Show Full CardNumber and CVV.

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

DecryptAccountDetails

array

Sample Response Body

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {
    "DecryptAccountDetails": [
      {
        "SocialSecurityNumber": "433334343",
        "NameOnCard": "shailab gupta",
        "CardNumber": "4066850001000935",
        "CVC": "",
        "CardExpiryDate": "24/08",
        "CardStatus": "Active",
        "CardSequenceNumber": 1
      }
    ]
  }
}

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"
    },
    "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"
    },
    "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"
    }
  }
}

GetCardImage

Action: POST

Endpoint: /api/GetCardImage

POST /api/GetCardImage

Use this API to get the card image in bytes.

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

ProxyNumber

string

Mandatory

Proxy Number of the cardholder Valid values:0-9 Example:1005

Allowable Values:

19

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

CardImage

byte[]

Card image in bytes

MIMEType

string

MIME type Example : application/pdf, image/jpeg

Allowable Values:

127

Sample Response Body

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {
    "CardImage": "Q2FyZEltYWdl",
    "MIMEType": "image/jpeg"
  }
}

GetCardLoadLimit

Action: POST

Endpoint: /api/GetCardLoadLimit

POST /api/GetCardLoadLimit

Use this API to retrieve load limits set on account along with card limit and Card to card transfer limit.

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

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

This tag indicates the Proxy Number of the cardholder Valid values:0-9 Condition: At least one of Card Number/Proxy Number/Account Number is required. Example:1617358 etc.

Allowable Values:

19

AccountNumber

string

Conditional

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

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": "40668461******01",
  "ProxyNumber": "1321236",
  "AccountNumber": "60000000048964"
}
Response Fields Detail
Fields Description

CardLimit

Sample Response Body

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {
    "CardLimit": {
      "SingleTransactionLoadLimit": 1000.0,
      "DailyLoadLimitCount": 1,
      "DailyLoadLimitAmount": 1000.0,
      "WeeklyLoadLimitCount": 2,
      "WeeklyLoadLimitAmount": 1000.0,
      "MonthlyLoadLimitCount": 5,
      "MonthlyLoadLimitAmount": 1000.0,
      "CardLimitAmount": 1000.0,
      "CardToCardDailyLimitCount": 10,
      "CardToCardDailyLimitAmount": 1000.0
    }
  }
}

GetNonMonetaryActivity

Action: POST

Endpoint: /api/GetNonMonetaryActivity

POST /api/GetNonMonetaryActivity

Use this API to retrieve the log of non-monetary activities performed on a card account. The API fetches details such as a description of the change, activity date and time, user ID, and the source from which the activity was performed.

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

AccountNumber

string

Conditional

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

Allowable Values:

19

ProxyNumber

string

Conditional

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

Allowable Values:

19

BatchSize

Int32

Optional

Number of records to be returned in a page Valid Values: 0-9 Example:100,50 will return 100 or 50 transactions at once.

PageIndex

Int32

Optional

Page Number Valid Values: 0-9 Example: 0,1,2

FromDate

string

Conditional

Starting date of non-monetary activity search. Used as a criteria to get non monetary activity log. Valid Values:0-9 Format : MMDDYYYY Example : 03102015 Condition:Required only when ToDate is passed in the input.

Allowable Values:

8

ToDate

string

Conditional

End date of non-monetary activity search. Used as a criteria to get non-monetary activity log. Valid Values:0-9 Format : MMDDYYYY Example : 03112015 Condition:Required only when FromDate is passed in the input.

Allowable Values:

8

Sample Request Body
{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "AccountNumber": "60000000011558",
  "ProxyNumber": "1316315",
  "BatchSize": 100,
  "PageIndex": 0,
  "FromDate": "",
  "ToDate": ""
}
Response Fields Detail
Fields Description

NonMonetaryActivity

array

The non monetary activity details.

Sample Response Body

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {
    "NonMonetaryActivity": [
      {
        "SKEY": 31874,
        "UserID": "ccadmin",
        "Source": "CoreMoney",
        "ActivityDescription": "View Card - Notes & Activity Log",
        "ActivityOutCome": "Successful"
      },
      {
        "SKEY": 31873,
        "ActivityDateTime": "2020-12-01T00:00:00",
        "UserID": "ccadmin",
        "Source": "CoreMoney",
        "ActivityDescription": "View Card",
        "ActivityOutCome": "Successful"
      }
    ]
  }
}

LinkDelinkUserAccess

Action: POST

Endpoint: /api/LinkDelinkUserAccess

POST /api/LinkDelinkUserAccess

Use this API to display Link card and Delink Card option to cardholder.

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

IsLinkCardChecked_User

string

Optional

This tag decides whether to display or not to display the link card option of the primary card to the user. Valid values :0 = Do no display Link card option 1 = Display Link card Option Condition : Either any of the tag is mandatory.

Allowable Values:

1

IsDeLinkCardChecked_User

string

Optional

This tag decides whether to display or not to display the Delink card option of the primary card to the user. Valid values : 0 = Do no display Link card option 1 = Display Link card Option Condition : Either any of the tag is mandatory.

Allowable Values:

1

IsLinkCardChecked_SecondaryCard_User

string

Optional

This tag decides whether to display or not to display the link card option of the secondary card to the user. Valid values : 0 = Do no display Link card option 1 = Display Link card Option Condition : Either any of the tag is mandatory.

Allowable Values:

1

IsDelinkCardChecked_SecondaryCard_User

string

Optional

This tag decides whether to display or not to display the delink card option of the secondary card to the user. Valid values : 0 = Do no display Link card option 1 = Display Link card Option Condition : Either any of the tag is mandatory.

Allowable Values:

1

NotesReason

string

Optional

Description : This tag indicates PreDefined Memo Reasons.

Allowable Values:

50

NotesText

string

Optional

Description of Activity Performed on Account.

Allowable Values:

500

SSUserId

string

Optional

Description : This tag Indicates the Self Service User id

Allowable Values:

50

Sample Request Body
{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "IsLinkCardChecked_User": "1",
  "IsDeLinkCardChecked_User": "1",
  "IsLinkCardChecked_SecondaryCard_User": "1",
  "IsDelinkCardChecked_SecondaryCard_User": "1",
  "NotesReason": "1",
  "NotesText": "Disputing",
  "SSUserId": "qwerty"
}
Response Fields Detail
Fields Description

Sample Response Body

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {}
}

ManageHoldEmbossing

Action: POST

Endpoint: /api/ManageHoldEmbossing

POST /api/ManageHoldEmbossing

Use this API to hold embossing file generation of card. Release opton is used later when embossing file is needed.

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

HoldEmbossingFlag

string

Mandatory

Flag to decide hold or release the embossings of a card Valid values : 0 : Set Hold Embossing 1 : Release Hold Embossing Example : 0

Allowable Values:

2

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

Sample Response Body

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {}
}

ManageWalletOrSavingPocket

Action: POST

Endpoint: /api/ManageWalletOrSavingPocket

POST /api/ManageWalletOrSavingPocket

Use this API to add a wallet or saving pocket on a card account.

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

AccountNumber

string

Conditional

This tag indicates the Account Number of the cardholder. Valid values: 0-9 Example: 2000000000000396893 Condition:At least one of Account Number/CardNumber/ProxyNumber is required.

Allowable Values:

19

CardNumber

string

Conditional

This tag indicates the Card Number of the cardholder Valid values:0-9 Clear Card Number. Example: *********4567[For Compliance masked BIN and Extended BIN]. Condition:At least one of Account Number/CardNumber/ProxyNumber is required.

Allowable Values:

16

ProxyNumber

string

Conditional

This tag indicates the Proxy Number of the cardholder Valid values:0-9 Example:1005 Condition:t least one of Account Number/CardNumber/ProxyNumber is required.

Allowable Values:

19

AddWalletOrSavingPocketDetails

array

Mandatory

This array contains wallet record details to be mapped on account Condition:At least one wallet record is required.

Notes

string

Optional

Description of the notes entered by the user. Valid Values : A-Z,0-9 Example : Please enter a value

Allowable Values:

500

NotesReason

string

Optional

Description: Predefined Memo Reasons. Valid Value: Please refer appendix Section 'Memo Reason'

Allowable Values:

50

Sample Request Body
{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.70",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "",
  "RequestDate": "",
  "AccountNumber": "60000000032679",
  "CardNumber": "4000000000002345",
  "ProxyNumber": "1316758",
  "AddWalletOrSavingPocketDetails": [
    {
      "AddWalletType": 0,
      "WalletID": 1009,
      "YearlyMaximumLimit": 100.0,
      "SavingPocketName": "",
      "AllowOutgoingSweep": 0
    }
  ],
  "Notes": "Cardholder called in to dispute a transaction. Warm transferred.",
  "NotesReason": "2"
}
Response Fields Detail
Fields Description

Sample Response Body

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {}
}

ReplacementCard

Action: POST

Endpoint: /api/ReplacementCard

POST /api/ReplacementCard

Use this API to replace a card by marking it Lost/Stolen/Damage/Other/Re-Issue/Personalize and providing a replacement card by generating a new card or using a preprinted card from inventory.

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

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

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

Reason

string

Mandatory

Reason for card replacement Valid values: 1 = Stolen 2 = Lost 3 = Damage 4 = Other 5 = Reissue 6 = Personalize Example : 2

Allowable Values:

1

DecisionFlag

string

Mandatory

Used for performing various operations when respective flag values defined below are passed. Valid values: 0 = Do not Generate new Embossing 1 = Generate New Embossing Note: When 'Reason' = 5 (Reissue) then Value of DecisionFlag would be '0'

Allowable Values:

2

CardFee

Int32

Optional

Flag to Decide Fee should be charged or not 1 = fee should be charged 0 = fee should not be charged.

DeliveryMechanism

string

Mandatory

Description:Shipment delivery mechanism. By Default Setting must be for standard Delivery Valid Values: 0-9 Example: 0 = Standard , 1 = Priority, 2 = Overnight 3 = USPS Mail (First Class) 4 = FedEx Economy 5 = 2nd business day

Allowable Values:

40

CardType

Int32

Mandatory

Type of card Valid Values : 0 = Card from Shelf 1 = Print New Card

NewCardNumber

string

Conditional

Card Number of New/Personalized card. Ex: *********1234567[For Compliance masked BIN and Extended BIN] Valid values are 0-9 Clear Card Number Condition: NewCardNumber is required, if value of CardType tag is 0.

Allowable Values:

16

NameOnCard

string

Conditional

Name to be Embossed on Card Valid values are A-Z, a-z, 0-9. Example: Hudson M Charles Condition: Mandatory when setup is Automatic/Mandatory

Allowable Values:

28

IsCardMasked

string

Optional

This tag indicates whether CardNumber should be returned in masked form or in clear form. Valid Values: 0= Card Number without Masked in Resonse. 1= Card Number with Masked in Resonse. 2= No Card Number in Resonse. Condition:If No value is given then by default it returns Card Number with Masked in Response.

Allowable Values:

1

MemoFlag

string

Conditional

Possible Values: 1:Card Replacement on Legitimate Address 0:Card Replacement on Fraudulent Address Example : 1 Condition : when On Product, ReplaceWarningChangeAddr not null or zero and DecisionFlag = 1 and ReissueReason = 1 or 2

Allowable Values:

1

MemoDesc

string

Conditional

Description for Memo Condition : when On Product, ReplaceWarningChangeAddr not null or zero and DecisionFlag = 1 and ReissueReason = 1 or 2

Allowable Values:

2000

ShippingAddressFlag

string

Conditional

Decision flag to select Shipping Address Valid Values: '0' Ship to Existing Address '1' Ship to Other Address Example: 1 Condition: When Reason = 1 or 2 and DecisionFlag = 0 it will become optional else mandatory

Allowable Values:

1

ShipToFirstName

string

Optional

First Name for Shipping address Valid Values: A-Z,a-z. Example: TestName Condition:It is mandatory when value of ShippingAddressFlag =1

Allowable Values:

50

ShipToMiddleName

string

Optional

Middle Name for Shipping address Valid Values: A-Z,a-z. Example: MName

Allowable Values:

50

ShipToLastName

string

Optional

Last Name for Shipping address Valid Values: A-Z,a-z. Example: LastName Condition:It is mandatory when value of ShippingAddressFlag =1

Allowable Values:

50

ShipToAddressLine1

string

Conditional

Address Line 1 for Shipping address Valid values:A-Z, a-z, 0-9 Example: 1 Meca Way Condition:It is mandatory when value of ShippingAddressFlag =1

Allowable Values:

50

ShipToAddressLine2

string

Optional

Address Line 2 for Shipping address Valid values:A-Z, a-z, 0-9 Example:15 Penang Street Point

Allowable Values:

50

ShipToCity

string

Conditional

City for Shipping address Valid values:A-Z, a-z, 0-9 Example:Norcross Condition:It is mandatory when value of ShippingAddressFlag =1

Allowable Values:

25

ShipToState

string

Conditional

State for Shipping address Valid Values:A-Z,a-z Example:NY Condition:It is mandatory when value of ShippingAddressFlag =1 Refer Appendix Section: State Codes (US)

Allowable Values:

3

ShipToPostalCode

string

Conditional

ZIP code for Shipping address Valid values:A-Z, a-z,0-9 Example: 30093 Condition:It is mandatory when value of ShippingAddressFlag =1

Allowable Values:

10

ShipToCountry

string

Conditional

Country Code for Shipping address Valid values are A-Z, a-z Example: US Condition:It is mandatory when value of ShippingAddressFlag =1 Refer Appendix Section : Country Code Values

Allowable Values:

2

Sample Request Body
{
  "APIVersion": "1.4",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "CardNumber": "4066850001000935",
  "AccountNumber": "",
  "ProxyNumber": "1316728",
  "Reason": "1",
  "DecisionFlag": "1",
  "CardFee": 120,
  "DeliveryMechanism": "1",
  "CardType": 1,
  "NewCardNumber": "",
  "NameOnCard": "",
  "IsCardMasked": "1",
  "MemoFlag": "1",
  "MemoDesc": "Stolen",
  "ShippingAddressFlag": "",
  "ShipToFirstName": "",
  "ShipToMiddleName": "",
  "ShipToLastName": "",
  "ShipToAddressLine1": "",
  "ShipToAddressLine2": "",
  "ShipToCity": "",
  "ShipToState": "",
  "ShipToPostalCode": "",
  "ShipToCountry": ""
}
Response Fields Detail
Fields Description

CardNumber

string

Clear Card Number of the cardholder Valid values: 0-9 Example: 123456******0001

Allowable Values:

16

ProxyNumber

string

Proxy Number of the cardholder Valid values:0-9 Example:1005

Allowable Values:

19

Sample Response Body

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {
    "CardNumber": "406683******6085",
    "ProxyNumber": "1316756"
  }
}

ResetCardGeneratedStatus

Action: POST

Endpoint: /api/ResetCardGeneratedStatus

POST /api/ResetCardGeneratedStatus

Use this API to set the Generated status of card to its previous status.

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

CardGeneratedStatus

string

Generated Status of Card Example :New Card Pending Activation

Allowable Values:

40

Sample Response Body

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {
    "CardGeneratedStatus": "Active"
  }
}

RetrieveProductWallets

Action: POST

Endpoint: /api/RetrieveProductWallets

POST /api/RetrieveProductWallets

Use this API to retrieve the wallets available on the 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

InstitutionID

Int32

Mandatory

This tag indicates Institution ID of product. Example : 1230 etc.

Allowable Values:

10

ProductID

Int32

Mandatory

This tag indicates acctid of product which has MCC setup. Example : 2289 etc.

Allowable Values:

10

BatchSize

Int32

Optional

This tag indicates size of a wallet Batch Valid values:0-9 Example:1,2 etc.

Allowable Values:

3

PageIndex

Int32

Optional

This tag indicates size of each Page. Valid values:0-9 Example:1,2 etc.

Allowable Values:

5

Sample Request Body
{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.70",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "",
  "RequestDate": "",
  "InstitutionID": 1230,
  "ProductID": 2270,
  "BatchSize": 0,
  "PageIndex": 0
}
Response Fields Detail
Fields Description

WalletList

array

Sample Response Body

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {
    "WalletList": [
      {
        "InstitutionID": null,
        "ProductID": 2289,
        "WalletMasterID": 1004,
        "WalletID": 1006,
        "MCCPlanName": null,
        "WalletName": "US Dollar",
        "WalletType": 1,
        "AutoLinkWallet": "0",
        "WalletCurrencyCodeNumeric": null,
        "WalletCurrencyCodeAlphabetic": null,
        "AllowLoads": true,
        "AllowUnloads": true,
        "AllowSchemeDebitTransactions": true,
        "AllowSchemeCreditTransactions": true,
        "AllowIncomingWalletTransfer": true,
        "AllowOutgoingWalletTransfer": true,
        "AllowOutgoingSweep": true,
        "AllowIncomingSweep": true,
        "YearlyMaximumLimit": 300.0,
        "ForfeitBalance": 0,
        "YearlyRolloverAmount": 0.0,
        "GracePeriodInDays": 0,
        "HealthcareRealTimeSubstantiationDetails": {
          "HealthCareEligibleAmount": false,
          "PrescriptionEligibleAmount": false,
          "ClinicOrOtherHealthCareEligibleAmount": false,
          "DentalCareEligibleAmount": false,
          "VisionOrOpticalEligibleAmount": false
        },
        "CreationDateTime": "2020-02-10T00:00:00",
        "Priority": 1,
        "Status": "1"
      }
    ]
  }
}

SearchWalletAccount

Action: POST

Endpoint: /api/SearchWalletAccount

POST /api/SearchWalletAccount

Use this API to retrieve the wallets available along with its relevant information at the card account level.

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

AccountNumber

string

Conditional

This tag indicates the Account Number of the cardholder. Valid values: 0-9 Example: 2000000000000396893 Condition:At least one of Account Number/CardNumber/ProxyNumber is required.

Allowable Values:

19

CardNumber

string

Conditional

This tag indicates the Card Number of the cardholder Valid values:0-9 Clear Card Number. Example: *********4567[For Compliance masked BIN and Extended BIN]. Condition:At least one of Account Number/CardNumber/ProxyNumber is required.

Allowable Values:

16

ProxyNumber

string

Conditional

This tag indicates the Proxy Number of the cardholder Valid values:0-9 Example:1005 Condition:t least one of Account Number/CardNumber/ProxyNumber is required.

Allowable Values:

19

WalletID

Int32

Optional

This tag indicates Wallet ID of wallet mapped on account Valid values:0-9 Example:1005

Allowable Values:

10

BatchSize

Int32

Optional

This tag indicates size of a wallet Batch Valid values:0-9 Example:1,2 etc.

Allowable Values:

3

PageIndex

Int32

Optional

This tag indicates size of each Page. Valid values:0-9 Example:1,2 etc.

Allowable Values:

5

Sample Request Body
{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.70",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "AccountNumber": "60000000032679",
  "CardNumber": "4000000000002345",
  "ProxyNumber": "1316758",
  "WalletID": 0,
  "BatchSize": 0,
  "PageIndex": 0
}
Response Fields Detail
Fields Description

WalletList

array

Sample Response Body

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {
    "WalletList": [
      {
        "InstitutionID": 1230,
        "AccountNumber": "60000000035094",
        "WalletID": 1007,
        "WalletType": 4,
        "WalletOrSavingPocketName": "HC",
        "BeginningBalance": -22.0,
        "CurrentBalance": 17.0,
        "WalletAvailableBalance": 17.0,
        "WalletCurrencyCodeNumeric": "840",
        "WalletCurrencyCodeAlphabetic": null,
        "CreationDateTime": "2020-02-10T00:00:00",
        "ClosedDateTime": null,
        "Principal": -17.0,
        "Priority": 1,
        "Status": 1,
        "DisputesAmountNS": 0.0,
        "TotalOutStgAuthAmt": 0.0,
        "LastTransactionDateTime": "2020-02-10T00:00:00"
      }
    ]
  }
}

SecondaryCardSummarySS

Action: POST

Endpoint: /api/SecondaryCardSummarySS

POST /api/SecondaryCardSummarySS

Use this API to fetch information of secondary card including Manual card status and Limit.

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

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

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

SecondaryFlag

string

Mandatory

Secondary Card Flag to indicate type of card Valid values 0 = Regular Card 1 = Virtual Card 2 = Family Card

Allowable Values:

5

SecondaryCardType

string

Optional

Type of secondary card Valid Values:0-2 0 = Regular Card 1 = Virtual Card 2 = Family Card Example: 0 (Regular Card)

Allowable Values:

5

CardUserId

string

Optional

User ID of Cardholder Valid Values: A-Z,a-z,0-9. Example : max

Allowable Values:

32

Sample Request Body
{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "ProxyNumber": "1316751",
  "CardNumber": "",
  "SecondaryFlag": "0",
  "SecondaryCardType": "0",
  "CardUserId": "max"
}
Response Fields Detail
Fields Description

AccountNumber

string

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

ManualCardStatus

string

Manual Card Status Refer Appendix section : Card Status Values Example : Active

CardType

string

Type of card Valid Values: 0 = Regular Card 1 = Virtual Card 2 = Family Card Example : 0

ActualLimit

decimal

Actual limit of the Secondary card. Valid Values: 0-9 Format: XXX.XX Example: 1000:00

AvailableLimit

decimal

Remaining Secondary Card limit Exmaple: 50.00

CardNumber

string

Clear Card Number of the cardholder Valid values: 0-9 Example: 123456******0001

CardDetails

array

CardDetails

NumberOfAllowedTransaction

string

Number Of Transaction Allowed on the card. Example:5

FirstName

string

Cardholder First Name Valid Values: A-Z, a-z Example: Andrew

MiddleName

string

Cardholder Middle Name Valid values are A-Z, a-z, 0-9 Example: Charles

LastName

string

Cardholder Last Name Valid values:A-Z, a-z Example: Hudson

Sample Response Body

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {
    "AccountNumber": "60000000013984",
    "ManualCardStatus": "Active",
    "CardType": "1",
    "ActualLimit": 240.01,
    "AvailableLimit": 120.01,
    "CardNumber": "4066850001000935",
    "CardDetails": [
      {
        "CardNumber": "1316728",
        "ProxyNumber": "4066850001000935"
      }
    ],
    "NumberOfAllowedTransaction": "",
    "FirstName": "Steve",
    "MiddleName": "",
    "LastName": "Smith"
  }
}

SSCardReplacement

Action: POST

Endpoint: /api/SSCardReplacement

POST /api/SSCardReplacement

Use this API when customer wants to mark his card Lost/Stolen/Damage/Other.

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

CardStatus

string

Mandatory

Card Plastic Status Example : New Card Pending Activation

Allowable Values:

10

DateOfCardLostStolen

string

Optional

Date On which card is Lost or stolen Format:yyyymmdd Example : 20190227

Allowable Values:

8

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

NewCardNumber

string

Clear Card Number of the New card Valid values: 0-9 Example: 123456******0001

AccessToSS

string

Self Service Access present or not when the card is marked as Lost or stolen. valid values YES or NO Example = Yes

HeaderCall

string

Call center number to be displayed in header

ProductEmailId

string

E-mail id of the Product. Example : customerservice@cnb-enid.com

Sample Response Body

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {
    "NewCardNumber": "",
    "AccessToSS": "YES",
    "HeaderCall": "",
    "ProductEmailId": "kratika.shrivastava@corecard.com"
  }
}

UpdateCardDetail

Action: POST

Endpoint: /api/UpdateCardDetail

POST /api/UpdateCardDetail

Use this API to update cardholder's PII (personal identification information), address information, and additional information (if applicable).

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

ClientID

string

Conditional

Indicate Client Id and echo in embossing file Valid Values: 1422245 Format:XXXXX

Allowable Values:

50

CardNumber

string

Conditional

This tag indicates the Card Number of the cardholder Valid values:0-9 Clear Card Number. Example: *********4567[For Compliance masked BIN and Extended BIN]. Condition:At least one of Account Number/CardNumber/ProxyNumber is required.

Allowable Values:

16

ProxyNumber

string

Conditional

This tag indicates the Proxy Number of the cardholder Valid values:0-9 E.g:1005 Condition:Atleast either of Account Number or Proxy number is required

Allowable Values:

19

Title

string

Optional

Title for the customer can be set by this tag. Valid Values: Refer Appendix section : Title Values Example: Mr. , Mrs, Dr.

Allowable Values:

9

FirstName

string

Mandatory

Cardholder First Name Valid Values: A-Z, a-z Example: Andrew

Allowable Values:

50

MiddleName

string

Optional

Cardholder Middle Name Valid values are A-Z, a-z, 0-9 Example: Charles

Allowable Values:

50

LastName

string

Mandatory

Cardholder Last Name Valid values:A-Z, a-z Example: Hudson

Allowable Values:

50

SecondLastName

string

Optional

Second Last Name Valid values are A-Z, a-z, 0-9 Example: Test

Allowable Values:

40

NameOnCard

string

Mandatory

Name to be Embossed on Card Valid values are A-Z, a-z, 0-9. Example: Hudson M Charles

Allowable Values:

28

DateOfBirth

datetime

Mandatory

DOB of cardholder Format: MM/DD/YYYY Valid Values: 0-9 Example:- 03/26/1986

MotherMaidenName

string

Optional

Mother’s Maiden Name Valid Values: A-Z,a-z

Allowable Values:

40

SocialSecurityNumber

string

Optional

Social Security Number of Card Holder Valid Value:0-9 Ex: 123456789 Condition:At least one of SocialSecurityNumber, TaxID or IDName field should be passed in the input as Identification details

Allowable Values:

9

IDName

string

Optional

ID Code representing Name of ID Valid Values: 0-9 Example 05 Condition:At least one of SocialSecurityNumber, TaxID or IDName field should be passed in the input as Identification details Refer Appendix section : ID Name Values

Allowable Values:

2

IDNumber

string

Optional

Last 4 Digits of Primary ID Valid Values: 0-9 Example: 4586

Allowable Values:

18

IDDescription

string

Optional

ID Description. Valid Values: A-Z,a-z, 0-9. Condition:ID Description Field will be ignored in case of ID Name other than '13 - Other ID'.

Allowable Values:

20

IDIssueCountry

string

Conditional

This tag indicates the country which has issued the ID. Valid values :A-Z, a-z Example: US Refer Appendix section : Country Code Values

Allowable Values:

2

IDIssueState

string

Optional

This tag indicates the state which has issued the ID. Valid Values:Two Digit State Code:A-Z,a-z Example:GA Country = US Refer Appendix section : State Codes (US)

Allowable Values:

3

IDIssueDate

datetime

Conditional

Identification Issue Date Format: MM/DD/YYYY Valid Values:0-9 Example: 03/26/1998

IDExpirationDate

datetime

Conditional

Expiration date of ID. Format: MM/DD/YYYY Valid Values:0-9 Example:12/12/2015

CustomAccountID

string

Conditional

Description: It can be any custom ID which is used to uniquely identify the Account. Valid values: A-Z, a-z, 0-9 Example:123456789 Condition:If Custom Account ID set on product as Enabled then it is mandatory.

Allowable Values:

25

AddressLine1

string

Mandatory

Address Line 1 of a Cardholder Valid values are A-Z, a-z, 0-9 Example: 15 Penang Street Point

Allowable Values:

50

AddressLine2

string

Optional

Address Line 2 of a Cardholder Valid values: A-Z, a-z, 0-9 Example: 15 Penang Street Point

Allowable Values:

50

Country

string

Mandatory

This tag indicates the country. Valid values :A-Z, a-z Example: US Refer Appendix section : Country Code Values

Allowable Values:

2

State

string

Mandatory

Cardholder State of residence Two Character State code should be used and not State Name. Refer Appendix section : State Codes (US) Example: GA Valid values are A-Z, a-z

Allowable Values:

3

City

string

Mandatory

Cardholder's City of residence Valid values: A-Z, a-z, 0-9 Example: Norcross

Allowable Values:

25

PostalCode

string

Mandatory

Cardholder Postal Code of Residence Valid Values:A-Z,a-z,0-9 Example: 30093

Allowable Values:

10

HomePhoneCountryCode

Int32

Optional

This tag indicates the Home Phone Country Code. Refer Appendix section : Phone Country Code Values

HomePhoneNumber

string

Conditional

Home Phone Number. Valid Values: 0-9 Example: 9812338769 Condition: It is Mandatory when Card Account Parameters is Set as Yes on Product.

Allowable Values:

10

HomePhoneExtension

Int32

Optional

Home Phone Extension Valid Values:0-9 Example:91

WorkPhoneCountryCode

Int32

Optional

Work Phone Country Code

WorkPhoneNumber

string

Conditional

Cardholder Work Phone Number Valid values:0-9 Example:9632581470 Condition:If validation parameter set on product as Work Phone) Appendix Section:Refer Appendix Validation Parameter

Allowable Values:

10

WorkPhoneExtension

Int32

Optional

Work Phone Extension

MobilePhoneCountryCode

Int32

Optional

Mobile Phone Country Code

FaxNumberCountryCode

Int32

Optional

Description:Country code of Fax number. Valid Values: 0-9 Format: 12 Example: 20

WorkFaxCountryCode

Int32

Optional

Description:Country code of WorkFax number. Valid Values: 0-9 Format: 12 Example: 20

MobilePhoneNumber

string

Conditional

Mobile Phone Number Valid Values: 0-9 Example: 9876543210

Allowable Values:

10

HomeFaxNumber

string

Optional

Cardholder Home Fax Number Valid values are 0-9 Example:9632581470

Allowable Values:

10

WorkFaxNumber

string

Optional

Cardholder's Work Fax Number Valid values: 0-9 Example:9632581470

Allowable Values:

10

EmailAddress1

string

Optional

E Mail Address 1 of Cardholder Valid Values: A-Z, a-z, 0-9. Example: sem_pp1@gmail.com

Allowable Values:

100

EmailAddress2

string

Optional

E Mail Address 2 of Card holder Ex: sem_pp1@gmail.com

Allowable Values:

100

NoteReason

string

Optional

Description : This tag indicates PreDefined Memo Reasons. Please refer appendix Section : Memo Reason

Allowable Values:

5

NotesText

string

Optional

Description of Activity Performed on Account.

Allowable Values:

2000

AlertEmailAddress

string

Optional

Email Address of Cardholder which should be used to send Alerts. Valid Values: A-Z, a-z, 0-9. Example: sem_pp1@gmail.com

Allowable Values:

100

UserField1

string

Optional

Used to save the User Field according to product setup for Account Level. Format in case of date: MMDDYYYY

Allowable Values:

40

UserField2

string

Optional

Used to save the User Field according to product setup for Account Level. Format in case of date: MMDDYYYY

Allowable Values:

40

UserField3

string

Optional

Used to save the User Field according to product setup for Account Level. Format in case of date: MMDDYYYY

Allowable Values:

40

UserField4

string

Optional

Used to save the User Field according to product setup for Account Level. Format in case of date: MMDDYYYY

Allowable Values:

40

UserField5

string

Optional

Used to save the User Field according to product setup for Account Level. Format in case of date: MMDDYYYY

Allowable Values:

40

Sample Request Body
{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "ClientID": "",
  "CardNumber": "4066846120012843",
  "ProxyNumber": "1316614",
  "Title": "",
  "FirstName": "Harshal",
  "MiddleName": "",
  "LastName": "Waje",
  "SecondLastName": "",
  "NameOnCard": "Harshal Waje",
  "DateOfBirth": "1986-03-26T00:00:00",
  "MotherMaidenName": "",
  "SocialSecurityNumber": "",
  "IDName": "02",
  "IDNumber": "12587",
  "IDDescription": "",
  "IDIssueCountry": "US",
  "IDIssueState": "ID",
  "IDIssueDate": "2017-05-17T00:00:00",
  "IDExpirationDate": "2024-12-24T00:00:00",
  "CustomAccountID": "",
  "AddressLine1": "",
  "AddressLine2": "V Time Square",
  "Country": "US",
  "State": "DC",
  "City": "Navi Mumbai",
  "PostalCode": "40061",
  "HomePhoneCountryCode": 0,
  "HomePhoneNumber": "2158795878",
  "HomePhoneExtension": 2,
  "WorkPhoneCountryCode": 0,
  "WorkPhoneNumber": "2158795874",
  "WorkPhoneExtension": 0,
  "MobilePhoneCountryCode": 0,
  "FaxNumberCountryCode": 10,
  "WorkFaxCountryCode": 20,
  "MobilePhoneNumber": "2158795875",
  "HomeFaxNumber": "",
  "WorkFaxNumber": "",
  "EmailAddress1": "harshal.waje@corecard.com",
  "EmailAddress2": "harshal.waje@corecard.com",
  "NoteReason": "",
  "NotesText": "",
  "AlertEmailAddress": "",
  "UserField1": "",
  "UserField2": "",
  "UserField3": "",
  "UserField4": "",
  "UserField5": ""
}
Response Fields Detail
Fields Description

AccountNumber

string

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

Sample Response Body

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {
    "AccountNumber": "60000000011558"
  }
}

UpdateCardLoadLimit

Action: POST

Endpoint: /api/UpdateCardLoadLimit

POST /api/UpdateCardLoadLimit

Use this API to update load limits set on account along with card limit and card to card transfer limit.

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

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

This tag indicates the Proxy Number of the cardholder Valid values:0-9 Condition: At least one of Card Number/Proxy Number/Account Number is required. Example:1617358 etc.

Allowable Values:

19

AccountNumber

string

Conditional

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

Allowable Values:

19

SingleTransactionLoadLimit

decimal

Optional

Maximum load amount allowed for a transaction Example : 500.00

Allowable Values:

10

DailyLoadLimitCount

Int32

Optional

Sum of Loads allowed on a card in a day Example : 3

Allowable Values:

2

DailyLoadLimitAmount

decimal

Optional

Number of Loads allowed on a card in a day Example : 3

Allowable Values:

10

WeeklyLoadLimitCount

Int32

Optional

Sum of Loads allowed on a card in a week Example : 3

Allowable Values:

2

WeeklyLoadLimitAmount

decimal

Optional

Number of Loads allowed on a card in a week Example : 3

Allowable Values:

10

MonthlyLoadLimitCount

Int32

Optional

Sum of Loads allowed on a card in a month Example : 3

Allowable Values:

2

MonthlyLoadLimitAmount

decimal

Optional

Number of Loads allowed on a card in a month Example : 3

Allowable Values:

10

CardLimitAmount

decimal

Optional

Card limit Example : 25000

Allowable Values:

10

CardToCardSingleTransactionAmount

decimal

Optional

Maximum amount allowed for a card to card transaction Example : 500.00

Allowable Values:

10

CardToCardDailyLimitCount

Int32

Optional

Sum of card to card transaction allowed on a card in a day Example : 3

Allowable Values:

2

CardToCardDailyLimitAmount

decimal

Optional

Number of card to card transaction allowed on a card in a day Example : 3

Allowable Values:

10

NotesReason

string

Optional

Description : This tag indicates PreDefined Memo Reasons. Please refer appendix Section : Memo Reason

Allowable Values:

50

NotesText

string

Optional

Notes entered by the user Valid Values : A-Z,0-9 Example : Card found

Allowable Values:

500

Sample Request Body
{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "CardNumber": "4066846120****14",
  "ProxyNumber": "1321236",
  "AccountNumber": "60000000048964",
  "SingleTransactionLoadLimit": 2000.0,
  "DailyLoadLimitCount": 1,
  "DailyLoadLimitAmount": 100.0,
  "WeeklyLoadLimitCount": 2,
  "WeeklyLoadLimitAmount": 200.0,
  "MonthlyLoadLimitCount": 3,
  "MonthlyLoadLimitAmount": 300.0,
  "CardLimitAmount": 5000.0,
  "CardToCardSingleTransactionAmount": 2000.0,
  "CardToCardDailyLimitCount": 5,
  "CardToCardDailyLimitAmount": 500.0
}
Response Fields Detail
Fields Description

Sample Response Body

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {}
}

UpdateWalletOrSavingPocketPriority

Action: POST

Endpoint: /api/UpdateWalletOrSavingPocketPriority

POST /api/UpdateWalletOrSavingPocketPriority

Use this API to override the wallet priority at the card account level.

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

AccountNumber

string

Conditional

This tag indicates the Account Number of the cardholder. Valid values: 0-9 Example: 2000000000000396893 Condition:At least one of Account Number/CardNumber/ProxyNumber is required.

Allowable Values:

19

CardNumber

string

Conditional

This tag indicates the Card Number of the cardholder Valid values:0-9 Clear Card Number. Example: *********4567[For Compliance masked BIN and Extended BIN]. Condition:At least one of Account Number/CardNumber/ProxyNumber is required.

Allowable Values:

16

ProxyNumber

string

Conditional

This tag indicates the Proxy Number of the cardholder Valid values:0-9 Example:1005 Condition:t least one of Account Number/CardNumber/ProxyNumber is required.

Allowable Values:

19

WalletOrSavingPocketDetails

array

Mandatory

This array contains wallet records to be updated

Sample Request Body
{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.70",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "",
  "RequestDate": "",
  "AccountNumber": "60000000032679",
  "CardNumber": "4000000000002345",
  "ProxyNumber": "1316758",
  "WalletOrSavingPocketDetails": [
    {
      "WalletID": 1141,
      "Priority": 2
    }
  ]
}
Response Fields Detail
Fields Description

WalletOrSavingPocketDetails

array

Sample Response Body

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {
    "WalletOrSavingPocketDetails": [
      {
        "WalletID": 1779,
        "WalletOrSavingPocketName": "HC",
        "Priority": 2
      }
    ]
  }
}

UserExternalCardInformation

Action: POST

Endpoint: /api/UserExternalCardInformation

POST /api/UserExternalCardInformation

Use this API to save the external debit card information in CoreCard system.

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

UniqueID

string

Mandatory

This tag indicates the unique ID against a particular request.

Allowable Values:

19

RequestType

string

Mandatory

This tag is used to indicate the operation to be performed using this API. Valid values : 0 = New Storage of information 1 = Update existing card information 2 = Get Card Information

Allowable Values:

1

CCInternalAID

string

Conditional

This tag indicates the CCInternalAID which was created against a CardNumber . Valid values:0-9 Exaple:1005 card holder Condition : This tag will be mandatory when Request Type value =1 or 2.

Allowable Values:

16

CardNumber

string

Conditional

Indicates the card number of the cardholder.  Condition: Mandatory if Request Type is 0.

Allowable Values:

16

CVC

string

Conditional

Last three digit present on back your card stripe. Valid Values : 0-9 Example: 213 Condition: Mandatory if Request Type is 0 or 1

Allowable Values:

3

CardExpiryDate

string

Conditional

Indicates Expiration Date of the card. Valid values : 0-9 Format: MM/YY Condition: Mandatory if Request Type is 0 or 1

Allowable Values:

5

NameOnCard

string

Optional

This tag indicates the name of the cardholder printed on the card. Valid values : Valid values are A-Z, a-z, 0-9. Example: Hudson M Charles

Allowable Values:

50

AddressLine1

string

Optional

Indicates the Address Line 1 of the user. Valid values:A-Z, a-z, 0-9  Example: 1 Meca Way

Allowable Values:

50

AddressLine2

string

Optional

Indicates the Address Line 2 of the user. Valid values:A-Z, a-z, 0-9  Example: 1 Meca Way

Allowable Values:

50

City

string

Optional

Indicates the cardholder's city of residence. Valid values: A-Z, a-z, 0-9 Example: Norcross

Allowable Values:

25

PostalCode

string

Optional

Cardholder Postal Code of Residence Valid Values:A-Z,a-z,0-9 Example: 30093

Allowable Values:

9

State

string

Optional

Cardholder State of residence Two Character State code should be used and not State Name. Refer Appendix section : State Codes (US) Example: GA Valid values are A-Z, a-z

Allowable Values:

100

Country

string

Optional

This tag indicates the country. Valid values :A-Z, a-z Example: US Refer Appendix section : Country Code Values

Allowable Values:

100

Sample Request Body
{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "UniqueID": "58452163",
  "RequestType": "0",
  "CCInternalAID": "",
  "CardNumber": "4066836120006077",
  "CVC": "158",
  "CardExpiryDate": "02/26",
  "NameOnCard": "Smith",
  "AddressLine1": "Lane1",
  "AddressLine2": "near Subway",
  "City": "New York City",
  "PostalCode": "34351",
  "State": "GA",
  "Country": "US"
}
Response Fields Detail
Fields Description

UniqueID

string

This tag indicates the unique ID against a particular request.

CCInternalAID

string

This tag indicates the CCInternalAID which was created against a CardNumber. Valid values:0-9 Example:1005

CardNumber

string

This tag indicates the Card Number of the cardholder Valid values:0-9

CVC

string

CVC/CVV of the card.

CardExpiryDate

string

Indicates Expiration Date of the card. Valid values : 0-9 Format: MM/YY

AddressLine1

string

This tag indicates the Address Line 1 of the cardholder. Valid values are A-Z, a-z, 0-9

AddressLine2

string

This tag indicates the Address Line 2 of the cardholder. Valid values are A-Z, a-z, 0-9

City

string

This tag indicates the Cardholder City of residence Valid values are A-Z, a-z, 0-9 Example: Norcross

PostalCode

string

This tag indicates the Postal code of cardholder residence Valid values are A-Z, a-z,0-9 Example:30093

Country

string

This tag indicates the country. Valid values :A-Z, a-z Example: US Refer Appendix section : Country Code Values

State

string

This tag indicates the Cardholder State of residence.

NameOnCard

string

This tag indicates the name of the cardholder printed on the card. Valid values : Valid values are A-Z, a-z, 0-9. Example: Hudson M Charles

Sample Response Body

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {
    "UniqueID": "58452163",
    "CCInternalAID": "4066836158645938",
    "CardNumber": "4066836120006077",
    "CVC": "158",
    "CardExpiryDate": "02/24",
    "AddressLine1": "AB",
    "AddressLine2": "CD",
    "City": "NoCross",
    "PostalCode": "34351",
    "Country": "US",
    "State": "GA",
    "NameOnCard": "Smith"
  }
}

ValidateCardActivation

Action: POST

Endpoint: /api/ValidateCardActivation

POST /api/ValidateCardActivation

Use this API to get validation parameters defined on the program to activate and register card.

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:

19

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

LinkedExistingUserID

string

Conditional

If a card is Linked Card or not. Valid Values: 0 :Pre-Login Activation 1 :Link Card Condition:While link new card required to pass

Allowable Values:

25

LoginUserProxyNumber

string

Conditional

Proxy Number of logged in user Valid Values:0-9 Example: 123456 Condition:Required when LinkedExistingUserID passed in input

Allowable Values:

19

CurrentPIN

string

Optional

Current Card PIN of four digits. Valid Values: 0-9

CVV2

string

Optional

Three digit printed on the back of the card . Valid Values - 0-9 Example: 213

CardExpiryDate

string

Optional

Expiration Date of the card. Format is (MMYYYY). Valid Values: 0-9 Example : 092020

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": "1316315",
  "LinkedExistingUserID": "",
  "LoginUserProxyNumber": "",
  "CurrentPIN": "0149",
  "CVV2": "152",
  "CardExpiryDate": "08/23",
  "FlowSessionID": ""
}
Response Fields Detail
Fields Description

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)

Allowable Values:

2

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)

Allowable Values:

2

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)

Allowable Values:

2

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)

Allowable Values:

2

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)

Allowable Values:

2

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

Allowable Values:

2

CardRegistered

string

Display whether card is registered or not. Valid Values: 0- Card not registered in Self Service 1- Card registered in Self Service Example: 0

Allowable Values:

0

CardLinked

string

Display whether card is linked with any self service user or not. Valid Values: 0- Card not Linked with any Self Service User 1- Card Linked with Self Service User Example: 0

Allowable Values:

0

RegistrationFlag

string

Returns whether registraion is allowed for this card or not. Valid Values: Yes or No Example: Yes

Allowable Values:

0

CardRegistrationValidation1

string

Returns the 'User Registration' parameters which is set as '1st registration Field' on Product.

Allowable Values:

0

CardRegistrationValidation2

string

Returns the 'User Registration' parameters which is set as '2nd registration Field' on Product.

Allowable Values:

0

CardRegistrationValidation3

string

Returns the 'User Registration' parameters which is set as '3rd registration Field' on Product.

Allowable Values:

0

CardRegistrationValidation4

string

Returns the 'User Registration' parameters which is set as '4th registration Field' on Product.

Allowable Values:

0

CardRegistrationValidation5

string

Returns the 'User Registration' parameters which is set as '5th registration Field' on Product.

Allowable Values:

0

CardRegistrationValidation6

string

It Returns the 'User Registration' parameters which is set as '6th registration Field' on Product.

Allowable Values:

0

CardRegistrationValidation7

string

Returns the 'User Registration' parameters which is set as '7th registration Field' on Product.

Allowable Values:

0

CardRegistrationValidation8

string

Returns the 'User Registration' parameters which is set as 8th registration Field' on Product.

Allowable Values:

0

CardRegistrationValidation9

string

Returns the 'User Registration' parameters which is set as '9th registration Field' on Product.

Allowable Values:

0

CardRegistrationValidation10

string

It Returns the 'User Registration' parameters which is set as '10th registration Field' on Product.

Allowable Values:

0

CardRegistrationValidation11

string

Returns the 'User Registration' parameters which is set as '11th registration Field' on Product.

Allowable Values:

0

CardRegistrationValidation12

string

Returns the 'User Registration' parameters which is set as '12th registration Field' on Product.

Allowable Values:

0

CardRegistrationValidation13

string

Returns the 'User Registration' parameters which is set as '13th registration Field' on Product.

Allowable Values:

0

CardRegistrationValidation14

string

Returns the 'User Registration' parameters which is set as '14th registration Field' on Product.

Allowable Values:

0

CardRegistrationValidation15

string

Returns the 'User Registration' parameters which is set as '15th registration Field' on Product.

Allowable Values:

0

CardActivationValidationDisp1

string

Returns the property in terms of Display/Entry for the 'Card Activation' parameters which is set as '1st Validation Field' on Product. Valid Values: 0=Display 1-Entry

CardActivationValidationDisp2

string

Returns the property in terms of Display/Entry for the 'Card Activation' parameters which is set as '2nd Validation Field' on Product. Valid Values: 0=Display 1-Entry

CardActivationValidationDisp3

string

Returns the property in terms of Display/Entry for the 'Card Activation' parameters which is set as '3rd Validation Field' on Product. Valid Values: 0=Display 1-Entry

CardActivationValidationDisp4

string

Returns the property in terms of Display/Entry for the 'Card Activation' parameters which is set as '4th Validation Field' on Product. Valid Values: 0=Display 1-Entry

CardActivationValidationDisp5

string

Returns the property in terms of Display/Entry for the 'Card Activation' parameters which is set as '5th Validation Field' on Product. Valid Values: 0=Display 1-Entry

CardActivationValidationDisp6

string

Returns the property in terms of Display/Entry for the 'Card Activation' parameters which is set as '6th Validation Field' on Product. Valid Values: 0=Display 1-Entry

CardRegistrationValidationDisp1

string

Returns the property in terms of Mandatory/Optional for the 'User Registration' parameters which is set as '1st registration Field' on Product.

Allowable Values:

0

CardRegistrationValidationDisp2

string

Returns the property in terms of Mandatory/Optional for the 'User Registration' parameters which is set as '2nd registration Field' on Product.

Allowable Values:

0

CardRegistrationValidationDisp3

string

Returns the property in terms of Mandatory/Optional for the 'User Registration' parameters which is set as '3rd registration Field' on Product.

Allowable Values:

0

CardRegistrationValidationDisp4

string

Returns the property in terms of Mandatory/Optional for the 'User Registration' parameters which is set as '4th registration Field' on Product.

Allowable Values:

0

CardRegistrationValidationDisp5

string

Returns the property in terms of Mandatory/Optional for the 'User Registration' parameters which is set as '5th registration Field' on Product.

Allowable Values:

0

CardRegistrationValidationDisp6

string

Returns the property in terms of Mandatory/Optional for the 'User Registration' parameters which is set as '6th registration Field' on Product.

Allowable Values:

0

CardRegistrationValidationDisp7

string

Returns the property in terms of Mandatory/Optional for the 'User Registration' parameters which is set as '7th registration Field' on Product.

Allowable Values:

0

CardRegistrationValidationDisp8

string

Returns the property in terms of Mandatory/Optional for the 'User Registration' parameters which is set as '8th registration Field' on Product.

Allowable Values:

0

CardRegistrationValidationDisp9

string

Returns the property in terms of Mandatory/Optional for the 'User Registration' parameters which is set as '9th registration Field' on Product.

Allowable Values:

0

CardRegistrationValidationDisp10

string

Returns the property in terms of Mandatory/Optional for the 'User Registration' parameters which is set as '10th registration Field' on Product.

Allowable Values:

0

CardRegistrationValidationDisp11

string

Returns the property in terms of Mandatory/Optional for the 'User Registration' parameters which is set as '11th registration Field' on Product.

Allowable Values:

0

CardRegistrationValidationDisp12

string

Returns the property in terms of Mandatory/Optional for the 'User Registration' parameters which is set as '12th registration Field' on Product.

Allowable Values:

0

CardRegistrationValidationDisp13

string

Returns the property in terms of Mandatory/Optional for the 'User Registration' parameters which is set as '13th registration Field' on Product.

Allowable Values:

0

CardRegistrationValidationDisp14

string

Returns the property in terms of Mandatory/Optional for the 'User Registration' parameters which is set as '14th registration Field' on Product. Valid Values : 0=Mandatory 1-Optional

Allowable Values:

0

CardRegistrationValidationDisp15

string

Returns the 'User Registration' parameters which is set as '15th registration Field' on Product.

Allowable Values:

0

RemainingLinkedCardAttempts

string

Number of attempts left to link card. Valid Values: 0-9 Example: 4

FlowSessionID

string

Reserved for future use

LongFormDisclosureENPDF

string

Long form disclosure agreement in English language in PDF format.

LongFormDisclosureESPDF

string

Long form disclosure agreement in Spanish language in PDF format.

LongFormDisclosureENJPG

string

Long form disclosure agreement in English language in JPG format.

LongFormDisclosureESJPG

string

Long form disclosure agreement in Spanish language in JPG format.

ShortFormDisclosureENPDF

string

Short form disclosure agreement in English language in PDF format.

ShortFormDisclosureESPDF

string

Short form disclosure agreement in Spanish language in PDF format.

ShortFormDisclosureENJPG

string

Short form disclosure agreement in English language in JPG format.

ShortFormDisclosureESJPG

string

Short form disclosure agreement in Spanish language in JPG format.

Sample Response Body

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {
    "CardActivationValidation1": "",
    "CardActivationValidation2": "",
    "CardActivationValidation3": "",
    "CardActivationValidation4": "",
    "CardActivationValidation5": "",
    "CardActivationValidation6": "",
    "CardRegistered": "0",
    "CardLinked": "YES",
    "RegistrationFlag": "Yes",
    "CardRegistrationValidation1": "",
    "CardRegistrationValidation2": "",
    "CardRegistrationValidation3": "",
    "CardRegistrationValidation4": "",
    "CardRegistrationValidation5": "",
    "CardRegistrationValidation6": "",
    "CardRegistrationValidation7": "",
    "CardRegistrationValidation8": "",
    "CardRegistrationValidation9": "",
    "CardRegistrationValidation10": "",
    "CardRegistrationValidation11": "",
    "CardRegistrationValidation12": "",
    "CardRegistrationValidation13": "",
    "CardRegistrationValidation14": "",
    "CardRegistrationValidation15": "",
    "CardActivationValidationDisp1": "",
    "CardActivationValidationDisp2": "",
    "CardActivationValidationDisp3": "",
    "CardActivationValidationDisp4": "",
    "CardActivationValidationDisp5": "",
    "CardActivationValidationDisp6": "",
    "CardRegistrationValidationDisp1": "",
    "CardRegistrationValidationDisp2": "",
    "CardRegistrationValidationDisp3": "",
    "CardRegistrationValidationDisp4": "",
    "CardRegistrationValidationDisp5": "",
    "CardRegistrationValidationDisp6": "",
    "CardRegistrationValidationDisp7": "",
    "CardRegistrationValidationDisp8": "",
    "CardRegistrationValidationDisp9": "",
    "CardRegistrationValidationDisp10": "",
    "CardRegistrationValidationDisp11": "",
    "CardRegistrationValidationDisp12": "",
    "CardRegistrationValidationDisp13": "",
    "CardRegistrationValidationDisp14": "",
    "CardRegistrationValidationDisp15": "",
    "RemainingLinkedCardAttempts": "",
    "FlowSessionID": "",
    "LongFormDisclosureENPDF": "TnC_1739_20210107_191704.pdf",
    "LongFormDisclosureESPDF": "",
    "LongFormDisclosureENJPG": "",
    "LongFormDisclosureESJPG": "",
    "ShortFormDisclosureENPDF": "",
    "ShortFormDisclosureESPDF": "",
    "ShortFormDisclosureENJPG": "",
    "ShortFormDisclosureESJPG": ""
  }
}