User Management

The CoreCard system provides various APIs to manage the self-service portal login. These have various functionalities, such as self-service user registration, card activation, PIN reset, linking or delinking a card account to a self-service portal login ID, and updating answers to security questions.

CardholderRegistration

Action: POST

Endpoint: /api/CardholderRegistration

POST /api/CardholderRegistration

Use this API to register user by capturing PII data , Pin information, Security question's answers and password.

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
NewUserID string Mandatory	New User ID Valid Values as A-Z, 0-9. Example: NewUser123 Allowable Values: 100
AddressLine1 string Conditional	Address Line 1 of the Cardholder Valid values : A-Z, a-z, 0-9 Example: 15 Penang Street Point Condition: Mandatory if required for user registration else Optional 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: Mandatory if required for user registration else Optional Allowable Values: 40
Country string Optional	This tag indicates the country of the cardholder. It should be 2 character code. Valid values :A-Z, a-z Example: US Appendix Section: Country Code Values Allowable Values: 10
City string Conditional	Cardholder's City of residence Valid values: A-Z, a-z, 0-9 Example: Norcross Condition : Mandatory if required for user registration else Optional Allowable Values: 25
PostalCode string Conditional	Cardholder Postal Code of Residence Valid Values:A-Z,a-z,0-9 Example: 30093 Condition : Mandatory if required for user registration else Optional Allowable Values: 10
State string Conditional	Cardholder State of residence Valid values are A-Z, a-z Example: GA Please refer Appendix Section : State Codes(US) Condition : Mandatory if required for user registration else Optional Allowable Values: 5
EmailAddress string Conditional	E Mail Address of Cardholder Valid Values: A-Z, a-z, 0-9 @ . Example: ansh @gmail.com Condition : Mandatory if required for user registration else Optional Allowable Values: 100
CurrentPassword string Conditional	Current Password of Cardholder. Valid Values: A-Z, a-z,0-9, Special characters. Example: Test123! Condition : Mandatory if required for user registration else Optional Allowable Values: 15
NewPassword string Conditional	New Password of Cardholder. Valid Values: A-Z, a-z,0-9, Special characters. Example: Test123! Condition : Mandatory if required for user registration else Optional Allowable Values: 15
CurrentPIN string Conditional	Four Digit Current PIN Valid Values: 0-9 Example: 1346 Condition : Mandatory if required for user registration else Optional Allowable Values: 4
NewPIN string Conditional	Four Digit New PIN of the card Valid Values: 0-9 Example:1346 Condition : Mandatory if required for user registration else Optional Allowable Values: 4
SSNLast4Digits string Conditional	Last 4 digits of Social Security Number of a Cardholder Valid values :0-9 Example: 6789 Condition : Mandatory if required for user registration else Optional Allowable Values: 9
DateOfBirth string Conditional	Date of Birth of cardholder Format: MM/DD/YYYY Valid Values: 0-9 Example: 03/26/1986 Condition : Mandatory if required for user registration else Optional Allowable Values: 10
CVCorCVV string Conditional	CVV of the card Example : 546 Condition : Mandatory if required for user registration else Optional Allowable Values: 3
CardExpirationDate string Conditional	Expiration Date of the card. Valid Values: 0-9 DateFormat : MMYY Example : 0925 Condition : Mandatory if required for user registration else Optional Allowable Values: 8
ReadDisclosure string Optional	Disclosure value indicating the user has read terms and conditions. Allowable Values: 1
SecurityQuestionAnswers array Conditional
SACValue string Conditional	Used to hold SAC Value passed by user in input. Condition : Mandatory if required for user registration else Optional Allowable Values: 14

Fields

Description

APIVersion

string

Mandatory

Version of the API to be invoked Example: 1.3

Allowable Values:

IPAddress

string

Mandatory

IP Address of sender Example: 10.206.0.204

Allowable Values:

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:

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:

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:

SessionID

string

Optional

Reserved for future use

Allowable Values:

ANI

string

Optional

Reserved for future use

Allowable Values:

DNS

string

Optional

Reserved for future use

Allowable Values:

Language

string

Optional

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

Allowable Values:

RequestDate

string

Optional

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

Allowable Values:

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:

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:

NewUserID

string

Mandatory

New User ID Valid Values as A-Z, 0-9. Example: NewUser123

Allowable Values:

100

AddressLine1

string

Conditional

Address Line 1 of the Cardholder Valid values : A-Z, a-z, 0-9 Example: 15 Penang Street Point Condition: Mandatory if required for user registration else Optional

Allowable Values:

AddressLine2

string

Conditional

Address Line 2 of the Cardholder Valid values: A-Z, a-z, 0-9 Example: 1 mecca way Condition: Mandatory if required for user registration else Optional

Allowable Values:

Country

string

Optional

This tag indicates the country of the cardholder. It should be 2 character code. Valid values :A-Z, a-z Example: US Appendix Section: Country Code Values

Allowable Values:

City

string

Conditional

Cardholder's City of residence Valid values: A-Z, a-z, 0-9 Example: Norcross Condition : Mandatory if required for user registration else Optional

Allowable Values:

PostalCode

string

Conditional

Cardholder Postal Code of Residence Valid Values:A-Z,a-z,0-9 Example: 30093 Condition : Mandatory if required for user registration else Optional

Allowable Values:

State

string

Conditional

Cardholder State of residence Valid values are A-Z, a-z Example: GA Please refer Appendix Section : State Codes(US) Condition : Mandatory if required for user registration else Optional

Allowable Values:

EmailAddress

string

Conditional

E Mail Address of Cardholder Valid Values: A-Z, a-z, 0-9 @ . Example: ansh @gmail.com Condition : Mandatory if required for user registration else Optional

Allowable Values:

100

CurrentPassword

string

Conditional

Current Password of Cardholder. Valid Values: A-Z, a-z,0-9, Special characters. Example: Test123! Condition : Mandatory if required for user registration else Optional

Allowable Values:

NewPassword

string

Conditional

New Password of Cardholder. Valid Values: A-Z, a-z,0-9, Special characters. Example: Test123! Condition : Mandatory if required for user registration else Optional

Allowable Values:

CurrentPIN

string

Conditional

Four Digit Current PIN Valid Values: 0-9 Example: 1346 Condition : Mandatory if required for user registration else Optional

Allowable Values:

NewPIN

string

Conditional

Four Digit New PIN of the card Valid Values: 0-9 Example:1346 Condition : Mandatory if required for user registration else Optional

Allowable Values:

SSNLast4Digits

string

Conditional

Last 4 digits of Social Security Number of a Cardholder Valid values :0-9 Example: 6789 Condition : Mandatory if required for user registration else Optional

Allowable Values:

DateOfBirth

string

Conditional

Date of Birth of cardholder Format: MM/DD/YYYY Valid Values: 0-9 Example: 03/26/1986 Condition : Mandatory if required for user registration else Optional

Allowable Values:

CVCorCVV

string

Conditional

CVV of the card Example : 546 Condition : Mandatory if required for user registration else Optional

Allowable Values:

CardExpirationDate

string

Conditional

Expiration Date of the card. Valid Values: 0-9 DateFormat : MMYY Example : 0925 Condition : Mandatory if required for user registration else Optional

Allowable Values:

ReadDisclosure

string

Optional

Disclosure value indicating the user has read terms and conditions.

Allowable Values:

SecurityQuestionAnswers

array

Conditional

SACValue

string

Conditional

Used to hold SAC Value passed by user in input. Condition : Mandatory if required for user registration else Optional

Allowable Values:

Sample Request Body

{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "CardNumber": "4066836120006028",
  "ProxyNumber": "1316619",
  "NewUserID": "",
  "AddressLine1": "23 PLANT LN",
  "AddressLine2": "",
  "Country": "US",
  "City": "LA MESA",
  "PostalCode": "91942",
  "State": "CA",
  "EmailAddress": "harshalwaje8@mail.com",
  "CurrentPassword": "",
  "NewPassword": "",
  "CurrentPIN": "6028",
  "NewPIN": "0142",
  "SSNLast4Digits": "8759",
  "DateOfBirth": "",
  "CVCorCVV": "152",
  "CardExpirationDate": "0825",
  "ReadDisclosure": "",
  "SecurityQuestionAnswers": [
    {
      "ID": "",
      "Question": "",
      "Answer": ""
    }
  ],
  "SACValue": ""
}

Response Fields Detail

Fields	Description
IsSecurityQuestionAsked string	Security questions should be asked or not to the user. Valid values : Yes , No

Fields

Description

IsSecurityQuestionAsked

string

Security questions should be asked or not to the user. Valid values : Yes , No

Sample Response Body

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

ChangeAndSetPIN

Action: POST

Endpoint: /api/ChangeAndSetPIN

POST /api/ChangeAndSetPIN

Use this API to work as Set Pin API or Change PIN API based on Decision Flag. If Pin needs to be changed, new and current pin needs to be provided but in case of set pin ,only new pin needs to be provided.

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
CurrentPIN string Conditional	Current Card PIN of four digits. Valid Values: 0-9 Condition : This tag will be required when decision flag is 1 = Change PIN Example: 1346 Allowable Values: 4
DecisionFlag string Mandatory	Used for performing various operations when respective flag values defined below are passed. Valid Values : 0 = SET PIN 1 = Change PIN Allowable Values: 2
NewPin string Mandatory	Four Digit New PIN of the card Valid Values: 0-9 Example:1346 Allowable Values: 4
NoteReason string Optional	Flag for PreDefined Memo Reasons. Please refer appendix Section : Memo Reason Allowable Values: 50
NoteText string Optional	Notes entered by the user Valid Values : A-Z,0-9 Example : Card found Allowable Values: 396

Fields

Description

APIVersion

string

Mandatory

Version of the API to be invoked Example: 1.3

Allowable Values:

IPAddress

string

Mandatory

IP Address of sender Example: 10.206.0.204

Allowable Values:

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:

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:

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:

SessionID

string

Optional

Reserved for future use

Allowable Values:

ANI

string

Optional

Reserved for future use

Allowable Values:

DNS

string

Optional

Reserved for future use

Allowable Values:

Language

string

Optional

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

Allowable Values:

RequestDate

string

Optional

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

Allowable Values:

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:

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:

CurrentPIN

string

Conditional

Current Card PIN of four digits. Valid Values: 0-9 Condition : This tag will be required when decision flag is 1 = Change PIN Example: 1346

Allowable Values:

DecisionFlag

string

Mandatory

Used for performing various operations when respective flag values defined below are passed. Valid Values : 0 = SET PIN 1 = Change PIN

Allowable Values:

NewPin

string

Mandatory

Four Digit New PIN of the card Valid Values: 0-9 Example:1346

Allowable Values:

NoteReason

string

Optional

Flag for PreDefined Memo Reasons. Please refer appendix Section : Memo Reason

Allowable Values:

NoteText

string

Optional

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

Allowable Values:

396

Sample Request Body

{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "CardNumber": "4066846120012801",
  "ProxyNumber": "",
  "CurrentPIN": "",
  "DecisionFlag": "0",
  "NewPin": "0143",
  "NoteReason": "",
  "NoteText": ""
}

Response Fields Detail

Fields	Description

Sample Response Body

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

ChangePassword

Action: POST

Endpoint: /api/ChangePassword

POST /api/ChangePassword

Use this API to change password of self-service portal account when cardholder knows his current password. To authenticate User, system offers security questions to answer and after successful validation only, cardholder is allowed to change password.

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
UserId string Optional	UserId of the cardholder Valid Values: A-Z,a-z,0-9. Example : Sam Allowable Values: 128
Password string Mandatory	Password Valid Values:A-Z,a-z,0-9,Special Character Example: Test123! Allowable Values: 32
CurrentPassword string Mandatory	Current Password of Cardholder. Valid Values: A-Z, a-z,0-9, Special characters. Example: Test123! Allowable Values: 32
NewPassword string Mandatory	New Password of Cardholder. Valid Values: A-Z, a-z,0-9, Special characters. Example: Test123! Allowable Values: 32
ReEnterPassword string Mandatory	Re Enter the new password Valid Values:A-Z,a-z,0-9,Special Character. Example : Test123! Allowable Values: 32
SecurityQuestionAnswers array Optional
ForgotLinkFlag string Optional	Forgot Link Flag Valid Values : 1-ForgotPassword 2-ForgotUserID Example : 1 Allowable Values: 2

Fields

Description

APIVersion

string

Mandatory

Version of the API to be invoked Example: 1.3

Allowable Values:

IPAddress

string

Mandatory

IP Address of sender Example: 10.206.0.204

Allowable Values:

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:

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:

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:

SessionID

string

Optional

Reserved for future use

Allowable Values:

ANI

string

Optional

Reserved for future use

Allowable Values:

DNS

string

Optional

Reserved for future use

Allowable Values:

Language

string

Optional

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

Allowable Values:

RequestDate

string

Optional

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

Allowable Values:

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:

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:

UserId

string

Optional

UserId of the cardholder Valid Values: A-Z,a-z,0-9. Example : Sam

Allowable Values:

128

Password

string

Mandatory

Password Valid Values:A-Z,a-z,0-9,Special Character Example: Test123!

Allowable Values:

CurrentPassword

string

Mandatory

Current Password of Cardholder. Valid Values: A-Z, a-z,0-9, Special characters. Example: Test123!

Allowable Values:

NewPassword

string

Mandatory

New Password of Cardholder. Valid Values: A-Z, a-z,0-9, Special characters. Example: Test123!

Allowable Values:

ReEnterPassword

string

Mandatory

Re Enter the new password Valid Values:A-Z,a-z,0-9,Special Character. Example : Test123!

Allowable Values:

SecurityQuestionAnswers

array

Optional

ForgotLinkFlag

string

Optional

Forgot Link Flag Valid Values : 1-ForgotPassword 2-ForgotUserID Example : 1

Allowable Values:

Sample Request Body

{
  "APIVersion": "1.4",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "CardNumber": "",
  "ProxyNumber": "1314932",
  "UserId": "SSAPIUser",
  "Password": "Test12345!",
  "CurrentPassword": "Welocme123!",
  "NewPassword": "",
  "ReEnterPassword": "",
  "SecurityQuestionAnswers": [
    {
      "ID": "01",
      "Question": "What is your mother's maiden name",
      "Answer": "a"
    }
  ],
  "ForgotLinkFlag": "1"
}

Response Fields Detail

Fields	Description
LogOut string	Logs out from the application.

Fields

Description

LogOut

string

Logs out from the application.

Sample Response Body

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

DelinkCard

Action: POST

Endpoint: /api/DelinkCard

POST /api/DelinkCard

Use this API to delink cards from UserID. Primary card can also be delinked after delinking other cards.

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
LoggedInUserId string Mandatory	User id of logged in user Example : Samcard Allowable Values: 128
SACValue string Conditional	Security Access Code as per product setup Valid Values: A-Z 0-9 Example: DBCB277C, 97AF26B6 Condition: It will be asked as per product set up Allowable Values: 14

Fields

Description

APIVersion

string

Mandatory

Version of the API to be invoked Example: 1.3

Allowable Values:

IPAddress

string

Mandatory

IP Address of sender Example: 10.206.0.204

Allowable Values:

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:

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:

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:

SessionID

string

Optional

Reserved for future use

Allowable Values:

ANI

string

Optional

Reserved for future use

Allowable Values:

DNS

string

Optional

Reserved for future use

Allowable Values:

Language

string

Optional

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

Allowable Values:

RequestDate

string

Optional

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

Allowable Values:

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:

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:

LoggedInUserId

string

Mandatory

User id of logged in user Example : Samcard

Allowable Values:

128

SACValue

string

Conditional

Security Access Code as per product setup Valid Values: A-Z 0-9 Example: DBCB277C, 97AF26B6 Condition: It will be asked as per product set up

Allowable Values:

Sample Request Body

{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "ProxyNumber": "1314932",
  "CardNumber": "",
  "LoggedInUserId": "SSAPIUser",
  "SACValue": ""
}

Response Fields Detail

Fields	Description

Sample Response Body

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

DisplayEditMyInfo

Action: POST

Endpoint: /api/DisplayEditMyInfo

POST /api/DisplayEditMyInfo

Use this API to display 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
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

Fields

Description

APIVersion

string

Mandatory

Version of the API to be invoked Example: 1.3

Allowable Values:

IPAddress

string

Mandatory

IP Address of sender Example: 10.206.0.204

Allowable Values:

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:

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:

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:

SessionID

string

Optional

Reserved for future use

Allowable Values:

ANI

string

Optional

Reserved for future use

Allowable Values:

DNS

string

Optional

Reserved for future use

Allowable Values:

Language

string

Optional

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

Allowable Values:

RequestDate

string

Optional

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

Allowable Values:

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:

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:

Sample Request Body

{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "CardNumber": "",
  "ProxyNumber": "1316315"
}

Response Fields Detail

Fields	Description
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
DateOfBirth datetime	Date of Birth of cardholder Format: YYYY-MM-DDTHH:MM:SS Example: 2021-04-01T00:00:00
EmailAddress1 string	E Mail Address 1 of Cardholder Valid Values: A-Z, a-z, 0-9 @ . Example: sem_pp1@gmail.com
SecondaryEmailAddress string	Secondary E Mail Address 1 of Cardholder Valid Values: A-Z, a-z, 0-9 @ . Example: sem_pp1@gmail.com
AddressLine1 string	Address Line 1 of the Cardholder Valid values : A-Z, a-z, 0-9 Example: 15 Penang Street Point
AddressLine2 string	Address Line 2 of the Cardholder Valid values: A-Z, a-z, 0-9 Example: 1 mecca way
State string	Cardholder State of residence Valid values are A-Z, a-z Example: GA Please refer Appendix Section : State Codes (US)
City string	Cardholder's City of residence Valid values: A-Z, a-z, 0-9 Example: Norcross
Country string	Two Character Country Code Valid values :A-Z, a-z Example: US Refer Appendix section : Country Code Values
PostalCode string	Cardholder Postal Code of Residence Valid Values:A-Z,a-z,0-9 Example: 30093
Phone string	Phone number of cardholder Valid Values: 0-9 Example: 9876543210
WorkPhoneNumber string	Cardholder Work Phone Number Valid values:0-9 Example:9632581470
MobilePhoneNumber string	Cardholder's Mobile Phone Number Valid Values: 0-9 Example: 9876543210
PrimaryEmailAddressRequired string

Sample Response Body

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {
    "FirstName": "CHRISTOPHER",
    "MiddleName": "",
    "LastName": "BOLLMAN",
    "DateOfBirth": "1994-05-01T00:00:00",
    "EmailAddress1": "onwsatyaam.untwal@corecard.com",
    "SecondaryEmailAddress": "new.untwal@corecard.com",
    "AddressLine1": "23 PLANT LN",
    "AddressLine2": "",
    "State": "CA",
    "City": "LA MESA",
    "Country": "US",
    "PostalCode": "91942",
    "Phone": "1085551212",
    "WorkPhoneNumber": "1095551212",
    "MobilePhoneNumber": "1085551212"
  }
}

DualAuthRegistrationVerification

Action: POST

Endpoint: /api/DualAuthRegistrationVerification

POST /api/DualAuthRegistrationVerification

Use this API to register your card for Dual Authentication.

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
DualAuthFlag string Mandatory	Decision flag to decides whether Register/Validate/Enroll for Dual Authentication. Valid Values: 1 = Register the Dual Authentication paramters. 2 = Validate the Dual Authentication parameters. 3 = Enroll for Dual Authentication. Example: 1
DateOfBirth string Conditional	Date of Birth of cardholder Format: MM/DD/YYYY Valid Values: 0-9 Example:- 03/26/1986 Condition : If DOB is already present and set as one of the authenticationparameter ,then to be entered mandatorily. If DOB is not present and set as one of the authentication parameters, then needs to be registered mandatorily.
SSNLast4Digits string Conditional	Last 4 digits of Social Security Number of a Cardholder Valid values :0-9 Example: 6789 Condition : If SSN is already present and set as one of the authenticationparameter ,then to be entered mandatorily. If SSN is not present and set as one of the authentication parameters, then needs to be registered mandatorily. Allowable Values: 9
CVCorCVV string Conditional	Three digit printed on the back of the card . Valid Values - 0-9 Example: 213 Condition : mandatory to answer if set as one of the authentication parameters. Allowable Values: 3
CurrentPIN string Conditional	Four Digit Current PIN Valid Values: 0-9 Example: 1346 Condition : mandatory to answer if set as one of the authentication parameters. Allowable Values: 4
ProfilePassword string Conditional	Current profile password Valid Values: A-Z, a-z,0-9, Special characters. Example: Test123! Condition : mandatory to answer if set as one of the authentication parameters. Allowable Values: 15
IsUserEnabledinDualAuth string Conditional	whether user wants to enable Dual Authentication or not. Valid Values : 1 = Enable 0 = Disabled. Condition: TAG IsUserEnabledinDualAuth is mandatory only when tag DualAuthFlag = 3 and Product Field Force Opt In = No.
AuthenticationCode string Conditional	Authentication code received by the cardholder. Condition : mandatory to answer if set as one of the authentication parameters. Allowable Values: 6
Email string Conditional	E Mail Address of Cardholder Valid Values: A-Z, a-z, 0-9 @ . Example: ansh@gmail.com Condition : mandatory to answer if set as one of the authentication parameters.
MobileNumber string Conditional	Cardholder's Mobile Phone Number Valid Values: 0-9 Example: 9876543210 Condition : Mandatory when mobile number set as one of the dual authentication parameter.
UniqueID string Optional	Unique ID of Authentication Code
SocialSecurityNumber string Optional	Social Security Number of Cardholder Valid Values:0-9 Example:123456789 Allowable Values: 9

Fields

Description

APIVersion

string

Mandatory

Version of the API to be invoked Example: 1.3

Allowable Values:

IPAddress

string

Mandatory

IP Address of sender Example: 10.206.0.204

Allowable Values:

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:

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:

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:

SessionID

string

Optional

Reserved for future use

Allowable Values:

ANI

string

Optional

Reserved for future use

Allowable Values:

DNS

string

Optional

Reserved for future use

Allowable Values:

Language

string

Optional

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

Allowable Values:

RequestDate

string

Optional

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

Allowable Values:

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:

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:

DualAuthFlag

string

Mandatory

Decision flag to decides whether Register/Validate/Enroll for Dual Authentication. Valid Values: 1 = Register the Dual Authentication paramters. 2 = Validate the Dual Authentication parameters. 3 = Enroll for Dual Authentication. Example: 1

DateOfBirth

string

Conditional

Date of Birth of cardholder Format: MM/DD/YYYY Valid Values: 0-9 Example:- 03/26/1986 Condition : If DOB is already present and set as one of the authenticationparameter ,then to be entered mandatorily. If DOB is not present and set as one of the authentication parameters, then needs to be registered mandatorily.

SSNLast4Digits

string

Conditional

Last 4 digits of Social Security Number of a Cardholder Valid values :0-9 Example: 6789 Condition : If SSN is already present and set as one of the authenticationparameter ,then to be entered mandatorily. If SSN is not present and set as one of the authentication parameters, then needs to be registered mandatorily.

Allowable Values:

CVCorCVV

string

Conditional

Three digit printed on the back of the card . Valid Values - 0-9 Example: 213 Condition : mandatory to answer if set as one of the authentication parameters.

Allowable Values:

CurrentPIN

string

Conditional

Four Digit Current PIN Valid Values: 0-9 Example: 1346 Condition : mandatory to answer if set as one of the authentication parameters.

Allowable Values:

ProfilePassword

string

Conditional

Current profile password Valid Values: A-Z, a-z,0-9, Special characters. Example: Test123! Condition : mandatory to answer if set as one of the authentication parameters.

Allowable Values:

IsUserEnabledinDualAuth

string

Conditional

whether user wants to enable Dual Authentication or not. Valid Values : 1 = Enable 0 = Disabled. Condition: TAG IsUserEnabledinDualAuth is mandatory only when tag DualAuthFlag = 3 and Product Field Force Opt In = No.

AuthenticationCode

string

Conditional

Authentication code received by the cardholder. Condition : mandatory to answer if set as one of the authentication parameters.

Allowable Values:

string

Conditional

E Mail Address of Cardholder Valid Values: A-Z, a-z, 0-9 @ . Example: ansh@gmail.com Condition : mandatory to answer if set as one of the authentication parameters.

MobileNumber

string

Conditional

Cardholder's Mobile Phone Number Valid Values: 0-9 Example: 9876543210 Condition : Mandatory when mobile number set as one of the dual authentication parameter.

UniqueID

string

Optional

Unique ID of Authentication Code

SocialSecurityNumber

string

Optional

Social Security Number of Cardholder Valid Values:0-9 Example:123456789

Allowable Values:

Sample Request Body

{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "CardNumber": "123456******0026",
  "ProxyNumber": "1316315",
  "DualAuthFlag": "1",
  "DateOfBirth": "01/01/1990",
  "SSNLast4Digits": "1234",
  "CVCorCVV": "234",
  "CurrentPIN": "1234",
  "ProfilePassword": "A@1234",
  "IsUserEnabledinDualAuth": "1",
  "AuthenticationCode": "1",
  "Email": "Example@corecard.com",
  "MobileNumber": "1234567891",
  "UniqueID": "10",
  "SocialSecurityNumber": "154696523"
}

Response Fields Detail

Fields	Description

Sample Response Body

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

GetDualAuthDetails

Action: POST

Endpoint: /api/GetDualAuthDetails

POST /api/GetDualAuthDetails

Use this API to get Dual Authentication setup details.

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
ActivityPanel string Mandatory	Decision flag to get Dual Authentication details on the below mentioned activity. 1 = Card to Card Transfer 2 = Card to Bank Transfer 3 = Bank to Card Transfer 4 = Lost / Stolen 5 = Edit my Info 6 = Login 7 = Dual Authentication 8 = To register dual authentication details on card level 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
ProductID string Mandatory	ID of the Account's Product Valid Values:0-9 Example: 1739,1758 Allowable Values: 10
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

Fields

Description

APIVersion

string

Mandatory

Version of the API to be invoked Example: 1.3

Allowable Values:

IPAddress

string

Mandatory

IP Address of sender Example: 10.206.0.204

Allowable Values:

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:

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:

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:

SessionID

string

Optional

Reserved for future use

Allowable Values:

ANI

string

Optional

Reserved for future use

Allowable Values:

DNS

string

Optional

Reserved for future use

Allowable Values:

Language

string

Optional

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

Allowable Values:

RequestDate

string

Optional

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

Allowable Values:

ActivityPanel

string

Mandatory

Decision flag to get Dual Authentication details on the below mentioned activity. 1 = Card to Card Transfer 2 = Card to Bank Transfer 3 = Bank to Card Transfer 4 = Lost / Stolen 5 = Edit my Info 6 = Login 7 = Dual Authentication 8 = To register dual authentication details on card level

Allowable Values:

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:

ProductID

string

Mandatory

ID of the Account's Product Valid Values:0-9 Example: 1739,1758

Allowable Values:

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:

Sample Request Body

{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "ActivityPanel": "6",
  "CardNumber": "",
  "ProductID": "1111",
  "ProxyNumber": "1311010"
}

Response Fields Detail

Fields	Description
AuthParameter1 string	1st Dual authentication parameter. Valid Values: 1 = DateOfBirth 2 = Last4DigitsSSN 3 = CVVCVC2 4 = CurrentPIN 5 = ProfilePassword 6 = AuthenticationCode Example: 1
AuthParameter2 string	2nd Dual authentication parameter. Valid Values: 1 = DateOfBirth 2 = Last4DigitsSSN 3 = CVVCVC2 4 = CurrentPIN 5 = ProfilePassword 6 = AuthenticationCode Example: 2
AuthParameter3 string	3rd Dual authentication parameter. Valid Values: 1 = DateOfBirth 2 = Last4DigitsSSN 3 = CVVCVC2 4 = CurrentPIN 5 = ProfilePassword 6 = AuthenticationCode Example: 3
DualAuthenticationOnCard boolean	whether dual authentication is required or not. Valid values : Yes , No
DualRegistrationRequired boolean	whether registration of parameters is required. Valid values : Yes and No
NotificationTypeRequired string	Displays whether notification source value is present on database or not. Valid values: 1 = Mobile(Indicate mobile number is not updated in database.) 2 = Email(Indicate Email ID is not updated in database.) 3 = Both(Indicate both mobile and email id is not updated in database) Condition: This tag will only reflect when 'ActivitiyPanel' value would be '8' and Email, Mobile or Both are not available in system.
NotificationType string	Source to receive the authentication Valid values : 1 = SMS 2 = Email address 3 = Both
AuthCodeExpiration Int32	Expiration time of Authentication code.
AuthCodeLockoutDuration Int32	The time after which user will be automatically unlocked.
DualAuthCodeDefinition string	Flag for Dual Authentication Code definition. Valid values : 1 = System Defined 2 = User Defined
Email string	E Mail Address of Cardholder Valid Values: A-Z, a-z, 0-9 @ . Example: ansh @gmail.com
MobileNumber string	Cardholder's Mobile Phone Number Valid Values: 0-9 Example: 9876543210

Sample Response Body

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {
    "AuthParameter1": "1",
    "AuthParameter2": "2",
    "AuthParameter3": "6",
    "DualAuthenticationOnCard": true,
    "NotificationTypeRequired": "3",
    "NotificationType": "1",
    "AuthCodeExpiration": 1,
    "AuthCodeLockoutDuration": 1,
    "DualAuthCodeDefinition": "1",
    "Email": "email@email.com",
    "MobileNumber": "1234567890"
  }
}

GetLinkCardsDetails

Action: POST

Endpoint: /api/GetLinkCardsDetails

POST /api/GetLinkCardsDetails

Use this API to get details of all the linked cards with User ID linked with given Card or Proxy Number.

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 NOTE: Please provide Proxy Number used for user registration. 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 NOTE: Please provide CardNumber used for user registration. Condition : At least one of Card Number/Proxy Number is required. Allowable Values:** 16
IsCardMasked string Conditional	Flag to indicate Card Number should be returned in masked form or in clear form. Valid Values: 0 = Clear Card Number in Response. 1 = Masked Card Number in Response. 2 = No Card Number in Response. Note : Default value is 1 Example : Blank,0,1,2 Allowable Values: 1

Fields

Description

APIVersion

string

Mandatory

Version of the API to be invoked Example: 1.3

Allowable Values:

IPAddress

string

Mandatory

IP Address of sender Example: 10.206.0.204

Allowable Values:

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:

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:

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:

SessionID

string

Optional

Reserved for future use

Allowable Values:

ANI

string

Optional

Reserved for future use

Allowable Values:

DNS

string

Optional

Reserved for future use

Allowable Values:

Language

string

Optional

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

Allowable Values:

RequestDate

string

Optional

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

Allowable Values:

ProxyNumber

string

Conditional

Proxy Number of the cardholder Valid values:0-9 Example:1005 NOTE: Please provide Proxy Number used for user registration. Condition : At least one of Card Number/Proxy Number is required.

Allowable Values:

CardNumber

string

Conditional

Clear Card Number of the cardholder Valid values: 0-9 Example: 123456******0001 NOTE: Please provide CardNumber used for user registration. Condition : At least one of Card Number/Proxy Number is required.

Allowable Values:

IsCardMasked

string

Conditional

Flag to indicate Card Number should be returned in masked form or in clear form. Valid Values: 0 = Clear Card Number in Response. 1 = Masked Card Number in Response. 2 = No Card Number in Response. Note : Default value is 1 Example : Blank,0,1,2

Allowable Values:

Sample Request Body

{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "ProxyNumber": "1314932",
  "CardNumber": "",
  "IsCardMasked": "1"
}

Response Fields Detail

Fields	Description
LinkCardsDetail array

Fields

Description

LinkCardsDetail

array

Sample Response Body

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {
    "LinkCardsDetail": [
      {
        "AccountNumber": "60000000038338",
        "FirstName": "ASD",
        "CurrentBalance": 497.05,
        "ManualCardStatus": "9",
        "ManualCardStatusName": "Lost",
        "SubProductType": "29",
        "SubProductTypeDescription": "Access Cards",
        "ReloadsAllowed": "1",
        "ProxyNumber": "1317775",
        "ProductID": "1739",
        "ProductDescription": "",
        "LinkCardStatus": "2",
        "LoginFlag": "1",
        "CardType": "",
        "CardNumber": "406684******4195",
        "LinkCardAccess": "YES",
        "SACAsk": "No",
        "LongFormDisclosureENPDF": "TnC_1739_20210107_191704.pdf",
        "LongFormDisclosureESPDF": "",
        "LongFormDisclosureENJPG": "",
        "LongFormDisclosureESJPG": ""
      },
      {
        "AccountNumber": "60000000031960",
        "FirstName": "Bhavesh",
        "CurrentBalance": 100.01,
        "ManualCardStatus": "2",
        "ManualCardStatusName": "Active",
        "SubProductType": "32",
        "SubProductTypeDescription": "Prepaid Grant Card",
        "ReloadsAllowed": "1",
        "ProxyNumber": "1316646",
        "ProductID": "1758",
        "ProductDescription": "",
        "LinkCardStatus": "2",
        "LoginFlag": "1",
        "CardType": "",
        "CardNumber": "406681******2773",
        "LinkCardAccess": "YES",
        "DelinkCardAccess": "YES",
        "SACAsk": "No",
        "LongFormDisclosureENPDF": "TnC_1739_20210107_191704.pdf",
        "LongFormDisclosureESPDF": "",
        "LongFormDisclosureENJPG": "",
        "LongFormDisclosureESJPG": ""
      }
    ]
  }
}

ResetPIN

Action: POST

Endpoint: /api/ResetPIN

POST /api/ResetPIN

Use this API to reset PIN of the card by providing card/proxy Number to default PIN.

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
Notes string Optional	Notes entered by the user Valid Values : A-Z,0-9 Example : Card found Allowable Values: 396
NotesReason string Optional	PreDefined Memo Reasons. Please refer appendix Section : Memo Reason Allowable Values: 50

Fields

Description

APIVersion

string

Mandatory

Version of the API to be invoked Example: 1.3

Allowable Values:

IPAddress

string

Mandatory

IP Address of sender Example: 10.206.0.204

Allowable Values:

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:

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:

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:

SessionID

string

Optional

Reserved for future use

Allowable Values:

ANI

string

Optional

Reserved for future use

Allowable Values:

DNS

string

Optional

Reserved for future use

Allowable Values:

Language

string

Optional

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

Allowable Values:

RequestDate

string

Optional

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

Allowable Values:

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:

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:

Notes

string

Optional

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

Allowable Values:

396

NotesReason

string

Optional

PreDefined Memo Reasons. Please refer appendix Section : Memo Reason

Allowable Values:

Sample Request Body

{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "CardNumber": "",
  "ProxyNumber": "1316751",
  "Notes": "2",
  "NotesReason": ""
}

Response Fields Detail

Fields	Description
NewPIN string	Four Digit New PIN of the card Valid Values: 0-9 Example:1346 Allowable Values: 4

Fields

Description

NewPIN

string

Four Digit New PIN of the card Valid Values: 0-9 Example:1346

Allowable Values:

Sample Response Body

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

ResetPINAttempts

Action: POST

Endpoint: /api/ResetPINAttempts

POST /api/ResetPINAttempts

Use this API to reset an invalid PIN attempts counter. The invalid PIN attempt counter increases when a cardholder attempts an authorization transaction or other activity with an incorrect PIN. Once the invalid PIN counter is reset, cardholder will get the number of retry attempt as per PIN try counter configuration.

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
Notes string Optional	Notes entered by the user Valid Values : A-Z,0-9 Example : Card found Allowable Values: 396
NoteReason string Optional	Flag for PreDefined Memo Reasons. Please refer appendix Section : Memo Reason Allowable Values: 50

Fields

Description

APIVersion

string

Mandatory

Version of the API to be invoked Example: 1.3

Allowable Values:

IPAddress

string

Mandatory

IP Address of sender Example: 10.206.0.204

Allowable Values:

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:

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:

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:

SessionID

string

Optional

Reserved for future use

Allowable Values:

ANI

string

Optional

Reserved for future use

Allowable Values:

DNS

string

Optional

Reserved for future use

Allowable Values:

Language

string

Optional

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

Allowable Values:

RequestDate

string

Optional

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

Allowable Values:

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:

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:

Notes

string

Optional

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

Allowable Values:

396

NoteReason

string

Optional

Flag for PreDefined Memo Reasons. Please refer appendix Section : Memo Reason

Allowable Values:

Sample Request Body

{
  "APIVersion": "1.4",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "CardNumber": "4066846120012801",
  "ProxyNumber": "",
  "Notes": "",
  "NoteReason": ""
}

Response Fields Detail

Fields	Description
NumberOfPinAttempts string	Counter of Invalid PIN Attempts Valid Values: 0-9 Example : 2 Allowable Values: 3

Fields

Description

NumberOfPinAttempts

string

Counter of Invalid PIN Attempts Valid Values: 0-9 Example : 2

Allowable Values:

Sample Response Body

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

SaveEditMyInfo

Action: POST

Endpoint: /api/SaveEditMyInfo

POST /api/SaveEditMyInfo

Use this API to update a 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
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 Optional	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 Optional	Cardholder Last Name Valid values:A-Z, a-z Example: Hudson Allowable Values: 50
AddressLine1 string Optional	Address Line 1 of the 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 the Cardholder Valid values: A-Z, a-z, 0-9 Example: 1 mecca way Allowable Values: 50
POBOX string Optional	Cardholder's PO Box Number. Valid Values:0-9 Example : 1312276 Allowable Values: 10
City string Optional	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: 10
State string Optional	Cardholder State of residence Valid values are A-Z, a-z Example: GA Please refer Appendix Section : State Codes (US) Allowable Values: 5
Country string Optional	Two Character Country Code Valid values :A-Z, a-z Example: US Refer Appendix section : Country Code Values Allowable Values: 5
MobilePhoneNumber string Optional	Cardholder's Mobile Phone Number Valid Values: 0-9 Example: 9876543210 Allowable Values: 10
MobilePhoneCountryCode string Optional	Cardholder's Mobile Phone Country Code. Valid Values: 0-9 Example: 91 Allowable Values: 2
WorkPhoneCountryCode string Optional	Cardholder's work phone country code. Valid Values: 0-9 Example: 91 Allowable Values: 2
WorkPhoneNumber string Optional	Cardholder Work Phone Number Valid values:0-9 Example:9632581470 Allowable Values: 10
FaxNumber string Optional	Cardholder's FAX number. Valid values are 0-9 Example:9632581470 Allowable Values: 10
WorkPhoneExtension string Optional	Cardholder's work phone extension code. Valid Values: 0-9 Example: 1589 Allowable Values: 4
EmailAddress1 string Conditional	E Mail Address 1 of Cardholder Valid Values: A-Z, a-z, 0-9 @. Example: sem_pp1@gmail.com Condition: If the validation parameter is set on the product for Primary Email Address then it will be mandatory. Allowable Values: 100
WorkFaxNumber string Optional	Cardholder's Work Fax Number Valid values: 0-9 Example:9632581470 Allowable Values: 10
EmailAddress2 string Optional	E Mail Address 2 of Card holder Valid Values: A-Z, a-z, 0-9 @. Example : sem_pp1@gmail.com Allowable Values: 0
DateOfBirth string Optional	Date of Birth of cardholder Format: yyyymmdd Valid Values: 0-9 Example : 19800101 Allowable Values: 8
HomePhoneCountryCode string Optional	Home Phone Country Code Valid Values: 0-9 Example: 91 Allowable Values: 2
Phone string Optional	Phone number of cardholder Valid Values: 0-9 Example: 9876543210 Allowable Values: 19

Fields

Description

APIVersion

string

Mandatory

Version of the API to be invoked Example: 1.3

Allowable Values:

IPAddress

string

Mandatory

IP Address of sender Example: 10.206.0.204

Allowable Values:

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:

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:

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:

SessionID

string

Optional

Reserved for future use

Allowable Values:

ANI

string

Optional

Reserved for future use

Allowable Values:

DNS

string

Optional

Reserved for future use

Allowable Values:

Language

string

Optional

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

Allowable Values:

RequestDate

string

Optional

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

Allowable Values:

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:

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:

FirstName

string

Optional

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

Allowable Values:

MiddleName

string

Optional

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

Allowable Values:

LastName

string

Optional

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

Allowable Values:

AddressLine1

string

Optional

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

Allowable Values:

AddressLine2

string

Optional

Address Line 2 of the Cardholder Valid values: A-Z, a-z, 0-9 Example: 1 mecca way

Allowable Values:

POBOX

string

Optional

Cardholder's PO Box Number. Valid Values:0-9 Example : 1312276

Allowable Values:

City

string

Optional

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

Allowable Values:

PostalCode

string

Optional

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

Allowable Values:

State

string

Optional

Cardholder State of residence Valid values are A-Z, a-z Example: GA Please refer Appendix Section : State Codes (US)

Allowable Values:

Country

string

Optional

Two Character Country Code Valid values :A-Z, a-z Example: US Refer Appendix section : Country Code Values

Allowable Values:

MobilePhoneNumber

string

Optional

Cardholder's Mobile Phone Number Valid Values: 0-9 Example: 9876543210

Allowable Values:

MobilePhoneCountryCode

string

Optional

Cardholder's Mobile Phone Country Code. Valid Values: 0-9 Example: 91

Allowable Values:

WorkPhoneCountryCode

string

Optional

Cardholder's work phone country code. Valid Values: 0-9 Example: 91

Allowable Values:

WorkPhoneNumber

string

Optional

Cardholder Work Phone Number Valid values:0-9 Example:9632581470

Allowable Values:

FaxNumber

string

Optional

Cardholder's FAX number. Valid values are 0-9 Example:9632581470

Allowable Values:

WorkPhoneExtension

string

Optional

Cardholder's work phone extension code. Valid Values: 0-9 Example: 1589

Allowable Values:

EmailAddress1

string

Conditional

E Mail Address 1 of Cardholder Valid Values: A-Z, a-z, 0-9 @. Example: sem_pp1@gmail.com Condition: If the validation parameter is set on the product for Primary Email Address then it will be mandatory.

Allowable Values:

100

WorkFaxNumber

string

Optional

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

Allowable Values:

EmailAddress2

string

Optional

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

Allowable Values:

DateOfBirth

string

Optional

Date of Birth of cardholder Format: yyyymmdd Valid Values: 0-9 Example : 19800101

Allowable Values:

HomePhoneCountryCode

string

Optional

Home Phone Country Code Valid Values: 0-9 Example: 91

Allowable Values:

Phone

string

Optional

Phone number of cardholder Valid Values: 0-9 Example: 9876543210

Allowable Values:

Sample Request Body

{
  "APIVersion": "1.4",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "CardNumber": "",
  "ProxyNumber": "1316315",
  "FirstName": "CHRISTOPHER",
  "MiddleName": "",
  "LastName": "BOLLMAN",
  "AddressLine1": "23 PLANT LN",
  "AddressLine2": "",
  "City": "LA MESA",
  "PostalCode": "91942",
  "State": "CA",
  "Country": "US",
  "MobilePhoneNumber": "1095551212",
  "MobilePhoneCountryCode": "",
  "WorkPhoneCountryCode": "",
  "WorkPhoneNumber": "1095551212",
  "FaxNumber": "",
  "WorkPhoneExtension": "",
  "EmailAddress1": "onwsatyaam.untwal@corecard.com",
  "WorkFaxNumber": "",
  "EmailAddress2": "",
  "DateOfBirth": "",
  "HomePhoneCountryCode": "",
  "Phone": "1085551212"
}

Response Fields Detail

Fields	Description

Sample Response Body

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

SendAuthenticationCode

Action: POST

Endpoint: /api/SendAuthenticationCode

POST /api/SendAuthenticationCode

Use this API to send Authentication code 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
ProxyNumber string Mandatory	Proxy Number of the cardholder Valid values:0-9 Example:1005 Allowable Values: 19
NotificationType string Mandatory	Source to receive the authentication Valid values : 1 = SMS 2 = Email address 3 = Both Example: 1,2,3 Allowable Values: 2
ReSendAuthenticationCode string Optional	Resend authentication code. Valid Value : 1 = To resend authentication code. Example:1 Allowable Values: 2
ActivityPanel string Mandatory	Decision flag to get Dual Authentication details on the below mentioned activity. 1 = Card to Card Transfer 2 = Card to Bank Transfer 3 = Bank to Card Transfer 4 = Lost / Stolen 5 = Edit my Info 6 = Login 7 = Dual Authentication 8 = To register dual authentication details on card level Allowable Values: 1

Fields

Description

APIVersion

string

Mandatory

Version of the API to be invoked Example: 1.3

Allowable Values:

IPAddress

string

Mandatory

IP Address of sender Example: 10.206.0.204

Allowable Values:

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:

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:

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:

SessionID

string

Optional

Reserved for future use

Allowable Values:

ANI

string

Optional

Reserved for future use

Allowable Values:

DNS

string

Optional

Reserved for future use

Allowable Values:

Language

string

Optional

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

Allowable Values:

RequestDate

string

Optional

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

Allowable Values:

ProxyNumber

string

Mandatory

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

Allowable Values:

NotificationType

string

Mandatory

Source to receive the authentication Valid values : 1 = SMS 2 = Email address 3 = Both Example: 1,2,3

Allowable Values:

ReSendAuthenticationCode

string

Optional

Resend authentication code. Valid Value : 1 = To resend authentication code. Example:1

Allowable Values:

ActivityPanel

string

Mandatory

Allowable Values:

Sample Request Body

{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "ProxyNumber": "1316315",
  "NotificationType": "2",
  "ReSendAuthenticationCode": "1",
  "ActivityPanel": "6"
}

Response Fields Detail

Fields	Description
UniqueId string	Unique Id for the authentication code generates Valid Values:0-9 Example:513
AuthenticationCode string	Authentication code received by the cardholder. Valid Values : 0-9 Example : 5978
DualAuthCodeExpiration string	Time period after which Authentication code will be expired. Valid Values: 0-9 Example: 5

Fields

Description

UniqueId

string

Unique Id for the authentication code generates Valid Values:0-9 Example:513

AuthenticationCode

string

Authentication code received by the cardholder. Valid Values : 0-9 Example : 5978

DualAuthCodeExpiration

string

Time period after which Authentication code will be expired. Valid Values: 0-9 Example: 5

Sample Response Body

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {
    "UniqueId": "515",
    "AuthenticationCode": "565240",
    "DualAuthCodeExpiration": "5"
  }
}

UpdateSecurityAns

Action: POST

Endpoint: /api/UpdateSecurityAns

POST /api/UpdateSecurityAns

Use this API to update answers of security questions.

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
NewUserID string Optional	New User ID Valid Values as A-Z, 0-9. Example: NewUser123 Allowable Values: 128
ProxyNumber string Mandatory	Proxy Number of the cardholder Valid values:0-9 Example:1005 Allowable Values: 19
OldPassword string Optional	Old Password of Cardholder. Valid Values: A-Z, a-z,0-9, Special characters. Example: Test123! Allowable Values: 32
NewPassword string Optional	New Password of Cardholder. Valid Values: A-Z, a-z,0-9, Special characters.(depending upon the password policy) Example: Test123! Allowable Values: 32
SecurityQuestionAnswers array Optional	Security Questions
LoginFlag string Optional	Login Flag Valid Value : 11 ( new user id) Allowable Values: 2
DecisionFlag string Optional	Decision Flag Valid Value : FirstTimeUser Allowable Values: 20
ReadDisclosure string Optional	Disclosure value indicating the user has read terms and conditions. Allowable Values: 1

Fields

Description

APIVersion

string

Mandatory

Version of the API to be invoked Example: 1.3

Allowable Values:

IPAddress

string

Mandatory

IP Address of sender Example: 10.206.0.204

Allowable Values:

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:

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:

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:

SessionID

string

Optional

Reserved for future use

Allowable Values:

ANI

string

Optional

Reserved for future use

Allowable Values:

DNS

string

Optional

Reserved for future use

Allowable Values:

Language

string

Optional

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

Allowable Values:

RequestDate

string

Optional

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

Allowable Values:

NewUserID

string

Optional

New User ID Valid Values as A-Z, 0-9. Example: NewUser123

Allowable Values:

128

ProxyNumber

string

Mandatory

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

Allowable Values:

OldPassword

string

Optional

Old Password of Cardholder. Valid Values: A-Z, a-z,0-9, Special characters. Example: Test123!

Allowable Values:

NewPassword

string

Optional

New Password of Cardholder. Valid Values: A-Z, a-z,0-9, Special characters.(depending upon the password policy) Example: Test123!

Allowable Values:

SecurityQuestionAnswers

array

Optional

Security Questions

LoginFlag

string

Optional

Allowable Values:

DecisionFlag

string

Optional

Decision Flag Valid Value : FirstTimeUser

Allowable Values:

ReadDisclosure

string

Optional

Disclosure value indicating the user has read terms and conditions.

Allowable Values:

Sample Request Body

{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "NewUserID": "",
  "ProxyNumber": "1316315",
  "OldPassword": "",
  "NewPassword": "",
  "SecurityQuestionAnswers": [
    {
      "ID": "",
      "Question": "",
      "Answer": ""
    }
  ],
  "LoginFlag": "",
  "DecisionFlag": "1",
  "ReadDisclosure": ""
}

Response Fields Detail

Fields	Description

Sample Response Body

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

ValidatePin

Action: POST

Endpoint: /api/ValidatePin

POST /api/ValidatePin

Use this API to validate card PIN which is linked to the card number before user enroll to the self-service portal.

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
CardPIN string Mandatory	Four Digit Card PIN Valid Values: 0-9 Example: 1346 Allowable Values: 4

Fields

Description

APIVersion

string

Mandatory

Version of the API to be invoked Example: 1.3

Allowable Values:

IPAddress

string

Mandatory

IP Address of sender Example: 10.206.0.204

Allowable Values:

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:

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:

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:

SessionID

string

Optional

Reserved for future use

Allowable Values:

ANI

string

Optional

Reserved for future use

Allowable Values:

DNS

string

Optional

Reserved for future use

Allowable Values:

Language

string

Optional

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

Allowable Values:

RequestDate

string

Optional

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

Allowable Values:

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:

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:

CardPIN

string

Mandatory

Four Digit Card PIN Valid Values: 0-9 Example: 1346

Allowable Values:

Sample Request Body

{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "ProxyNumber": "4797333",
  "CardNumber": "",
  "CardPIN": "2485"
}

Response Fields Detail

Fields	Description

Sample Response Body

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