Card Activation

Primary and Secondary cards are generally issued in an inactive state to avoid the unauthorized usage of the card. The cardholder will require to activate the card by validating himself using any of the card activation channels. You can use CoreCard API to activate the card.

CardActivation

Action: POST

Endpoint: /api/CardActivation

POST /api/CardActivation

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

Request Fields Detail

Fields	Description
APIVersion string Mandatory	Version of the API to be invoked Example: 1.3 Allowable Values: 10
IPAddress string Mandatory	IP Address of sender Example: 10.206.0.204 Allowable Values: 15
Source string Mandatory	Source from where API Call is initiated. CoreCard have multiple value of source for internal system (CoreMoney, SelfService, IVR, MobileSelfService) For external system expected source will be WEB. Allowable Values: 50
CallerID string Optional	Caller Id of source from where API is initiated. It is End User phone number. Example: 7204454214 Condition - applicable in Case of IVR Allowable Values: 20
CalledID string Optional	Called Id of destination for which API is initiated. It is Corecard IVR number. Example: 7314145404 Condition - applicable in Case of IVR Allowable Values: 20
SessionID string Optional	Reserved for future use Allowable Values: 50
ANI string Optional	Reserved for future use Allowable Values: 0
DNS string Optional	Reserved for future use Allowable Values: 0
Language string Optional	Flag to retrieve error message in specific language Example: 'en' for English Allowable Values: 2
RequestDate string Optional	Request Date Time of API Format: MM-DD-YYYYTHH:MM:SS Example:- 11-12-2021T13:05:10 Allowable Values: 19
UniqueID string Optional	Reserved for future use Allowable Values: 19
UniqueIDFlag string Optional	Reserved for future use Allowable Values: 1
CardNumber string Conditional	Clear Card Number of the cardholder Valid values: 0-9 Example: 123456****0001 Condition:At least one of Card Number/Proxy Number is required. Allowable Values:** 16
ProxyNumber string Conditional	Proxy Number of the cardholder Valid values:0-9 Example:1005 Condition:At least one of Card Number/Proxy Number is required. Allowable Values: 19
FirstName string Conditional	Cardholder First Name Valid Values: A-Z, a-z Example: Andrew Condition: This is required if validation parameter set on product as part of Full Name Allowable Values: 40
MiddleName string Optional	Cardholder Middle Name Valid values are A-Z, a-z, 0-9 Example: Charles Condition: This is required if validation parameter set on product as part of Full Name Allowable Values: 40
LastName string Conditional	Cardholder Last Name Valid values:A-Z, a-z Example: Hudson Condition: This is required if validation parameter set on product as part of Full Name Allowable Values: 40
AddressLine1 string Conditional	Address Line 1 of the Cardholder Valid values : A-Z, a-z, 0-9 Example: 15 Penang Street Point Condition : This is required if validation parameter set on product as Full Address. Both AddressLine1 and AddressLine2 is Mandatory. Allowable Values: 40
AddressLine2 string Conditional	Address Line 2 of the Cardholder Valid values: A-Z, a-z, 0-9 Example: 1 mecca way Condition : This is required if validation parameter set on product as Full Address. Both AddressLine1 and AddressLine2 is Mandatory. Allowable Values: 40
EmailAddress1 string Conditional	E Mail Address 1 of Cardholder Valid Values: A-Z, a-z, 0-9 @ . Example: sem_pp1@gmail.com Condition : This is required if validation parameter set on product as EMail One Allowable Values: 100
DateOfBirth string Conditional	Date of Birth of cardholder Format: MM/DD/YYYY Valid Values: 0-9 Example:- 03/26/1986 Condition : This is required if validation parameter set on product as Birth Date Allowable Values: 10
LanguageIndicator string Conditional	Language Indicator Valid Values:A-Z,a-z. Example: en, where en represents 'English' Condition : This is required if validation parameter set on product as Language Indicator Allowable Values: 5
PostalCode string Conditional	Cardholder Postal Code of Residence Valid Values:A-Z,a-z,0-9 Example: 30093 Condition : This is required if validation parameter set on product as Postal Code Allowable Values: 10
HomePhoneNumber string Conditional	Home Phone Number. Valid Values: 0-9 Example: 9812338769 Condition : This is required if validation parameter set on product as Home Phone Allowable Values: 19
WorkPhoneNumber string Conditional	Cardholder Work Phone Number Valid values:0-9 Example:9632581470 Condition : This is required if validation parameter set on product as Work Phone Allowable Values: 19
SocialSecurityNumber string Conditional	Social Security Number of Cardholder Valid Values:0-9 Example:123456789 Condition :This is required if validation parameter set on product as Social Security Number of Cardholder. Allowable Values: 9
CardExpiryDate string Conditional	Expiration Date of the card. Format is (MMYYYY). Valid Values: 0-9 Example : 092020 Condition : This is required if validation parameter set on product as Card Expiration Date Allowable Values: 6
CurrentPIN string Conditional	Current Card PIN of four digits. Valid Values: 0-9 Example: 1346 Condition : This is required if validation parameter set on product as Current PIN Allowable Values: 4
CurrentPassword string Conditional	Current Password of Cardholder. Valid Values: A-Z, a-z,0-9, Special characters. Example: Test123! Condition : This is required if validation parameter set on product as Current Password Allowable Values: 9
NewPIN string Conditional	Four Digit New PIN of the card Valid Values: 0-9 Example:1346 Condition : This is required if validation parameter set on product as New PIN Allowable Values: 4
NewPassword string Conditional	New Password of Cardholder. Valid Values: A-Z, a-z,0-9, Special characters. Example: Test123! Condition : This is required if validation parameter set on product as New Password Allowable Values: 9
IDNumber string Conditional	Last 4 Digits of Primary ID Valid Values: 0-9 Example: 4586 Condition : This is required if validation parameter set on product as Last 4 Digits of Primary ID Allowable Values: 25
CVV2 string Conditional	Three digit printed on the back of the card. Valid Values - 0-9 Example: 213 Condition : This is required if validation parameter set on product as CVC2 Allowable Values: 4
BirthYear string Conditional	Birth Year Of CardHolder Valid Values: 0-9 Example:1994 Condition : This is required if validation parameter set on product as Birth Year Allowable Values: 4
CustomAccountID string Conditional	Any custom ID which is used to uniquely identify the Account. Valid values: A-Z, a-z, 0-9 Example:123456789 Condition: This is required if validation parameter set on product as Custom Account ID Allowable Values: 25
SSNLast4Digits string Conditional	Last 4 digits of Social Security Number of a Cardholder Valid values :0-9 Example: 6789 Condition : This is required if validation parameter set on product as Last 4 Digits of SSN Allowable Values: 4
CIPCollectSSN string Conditional	Social Security Number of a Cardholder Valid values :0-9 Example: 123456788 Condition : This tag is required if validation parameter set on product as CIPCollectSSN
CIPCollectIDType string Conditional	Type of ID. Valid Values: 0-12 Example 05 Appendix Section: ID Name Values Condition : This tag is required if validation parameter set on product as CIPCollectIDType
CIPCollectIDNumber string Conditional	ID Number. Valid Values: A-Z, a-z, 0-9 Example: NT1234569PM Condition : This tag is required if validation parameter set on product as CIPCollectIDNumber
CollectIDCountry string Conditional	Country of Identification proof. Valid Values:a-z, 0-9 Example: US Refer Appendix section : Country Code Values Condition : This tag is required if validation parameter set on product as CollectIDCountry
CollectIDDate string Conditional	ID Issue Date Format: MM/DD/YYYY Example : 09/16/2022 Condition : This tag is required if validation parameter set on product as CollectIDDate Allowable Values: 10
CollectIDExpirationDate string Conditional	Expiration date of ID. Format: MM/DD/YYYY Valid Values:0-9 Example:03/26/1998 Condition : This tag is required if validation parameter set on product as CollectIDExpirationDate Allowable Values: 10
CollectIDState string Conditional	ID Issue State Valid Values:A-Z,a-z Example:GA Appendix Section: State Codes (US) Condition : This tag is required if validation parameter set on product as CollectIDState Allowable Values: 10
SACValue string Conditional	Used to hold SAC Value passed by user in input. Condition: It will be asked as per product set up Allowable Values: 14

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:

UniqueID

string

Optional

Reserved for future use

Allowable Values:

UniqueIDFlag

string

Optional

Reserved for future use

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

Conditional

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

Allowable Values:

MiddleName

string

Optional

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

Allowable Values:

LastName

string

Conditional

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

Allowable Values:

AddressLine1

string

Conditional

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

Allowable Values:

AddressLine2

string

Conditional

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

Allowable Values:

EmailAddress1

string

Conditional

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

Allowable Values:

100

DateOfBirth

string

Conditional

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

Allowable Values:

LanguageIndicator

string

Conditional

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

Allowable Values:

PostalCode

string

Conditional

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

Allowable Values:

HomePhoneNumber

string

Conditional

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

Allowable Values:

WorkPhoneNumber

string

Conditional

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

Allowable Values:

SocialSecurityNumber

string

Conditional

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

Allowable Values:

CardExpiryDate

string

Conditional

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

Allowable Values:

CurrentPIN

string

Conditional

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

Allowable Values:

CurrentPassword

string

Conditional

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

Allowable Values:

NewPIN

string

Conditional

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

Allowable Values:

NewPassword

string

Conditional

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

Allowable Values:

IDNumber

string

Conditional

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

Allowable Values:

CVV2

string

Conditional

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

Allowable Values:

BirthYear

string

Conditional

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

Allowable Values:

CustomAccountID

string

Conditional

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

Allowable Values:

SSNLast4Digits

string

Conditional

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

Allowable Values:

CIPCollectSSN

string

Conditional

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

CIPCollectIDType

string

Conditional

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

CIPCollectIDNumber

string

Conditional

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

CollectIDCountry

string

Conditional

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

CollectIDDate

string

Conditional

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

Allowable Values:

CollectIDExpirationDate

string

Conditional

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

Allowable Values:

CollectIDState

string

Conditional

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

Allowable Values:

SACValue

string

Conditional

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

Allowable Values:

Sample Request Body

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

Response Fields Detail

Fields	Description
CardRegistered string	Display whether card is registered or not. Valid Values: 0 = Card not registered in Self Service 1 = Card registered in Self Service Example: 0
CardLinked string	Display whether card is linked with any self service user or not. Valid Values: 0 = Card not Linked with any Self Service User 1 = Card Linked with Self Service User Example: 0
FlowSessionID string	Reserved for future use

Fields

Description

CardRegistered

string

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

CardLinked

string

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

FlowSessionID

string

Reserved for future use

Sample Response Body

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

ValidateCardActivation

Action: POST

Endpoint: /api/ValidateCardActivation

POST /api/ValidateCardActivation

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

Request Fields Detail

Fields	Description
APIVersion string Mandatory	Version of the API to be invoked Example: 1.3 Allowable Values: 10
IPAddress string Mandatory	IP Address of sender Example: 10.206.0.204 Allowable Values: 15
Source string Mandatory	Source from where API Call is initiated. CoreCard have multiple value of source for internal system (CoreMoney, SelfService, IVR, MobileSelfService) For external system expected source will be WEB. Allowable Values: 50
CallerID string Optional	Caller Id of source from where API is initiated. It is End User phone number. Example: 7204454214 Condition - applicable in Case of IVR Allowable Values: 20
CalledID string Optional	Called Id of destination for which API is initiated. It is Corecard IVR number. Example: 7314145404 Condition - applicable in Case of IVR Allowable Values: 20
SessionID string Optional	Reserved for future use Allowable Values: 50
ANI string Optional	Reserved for future use Allowable Values: 0
DNS string Optional	Reserved for future use Allowable Values: 0
Language string Optional	Flag to retrieve error message in specific language Example: 'en' for English Allowable Values: 2
RequestDate string Optional	Request Date Time of API Format: MM-DD-YYYYTHH:MM:SS Example:- 11-12-2021T13:05:10 Allowable Values: 19
CardNumber string Conditional	Clear Card Number of the cardholder Valid values: 0-9 Example: 123456****0001 Condition: At least one of Card Number/Proxy Number is required. Allowable Values:** 19
ProxyNumber string Conditional	Proxy Number of the cardholder Valid values:0-9 Example:1005 Condition: At least one of Card Number/Proxy Number is required. Allowable Values: 19
LinkedExistingUserID string Conditional	If a card is Linked Card or not. Valid Values: 0 :Pre-Login Activation 1 :Link Card Condition:While link new card required to pass Allowable Values: 25
LoginUserProxyNumber string Conditional	Proxy Number of logged in user Valid Values:0-9 Example: 123456 Condition:Required when LinkedExistingUserID passed in input Allowable Values: 19
CurrentPIN string Optional	Current Card PIN of four digits. Valid Values: 0-9
CVV2 string Optional	Three digit printed on the back of the card . Valid Values - 0-9 Example: 213
CardExpiryDate string Optional	Expiration Date of the card. Format is (MMYYYY). Valid Values: 0-9 Example : 092020
FlowSessionID string Optional	Reserved for future use

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:

LinkedExistingUserID

string

Conditional

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

Allowable Values:

LoginUserProxyNumber

string

Conditional

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

Allowable Values:

CurrentPIN

string

Optional

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

CVV2

string

Optional

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

CardExpiryDate

string

Optional

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

FlowSessionID

string

Optional

Reserved for future use

Sample Request Body

{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "CardNumber": "",
  "ProxyNumber": "1316315",
  "LinkedExistingUserID": "",
  "LoginUserProxyNumber": "",
  "CurrentPIN": "0149",
  "CVV2": "152",
  "CardExpiryDate": "08/23",
  "FlowSessionID": ""
}

Response Fields Detail

Fields	Description
CardActivationValidation1 string	Returns the 'Card Activation-SelfService' parameters which is set as '1st Validation Field' on Product. Valid Values: Refer Appendix s section "Card Activation Validation Parameter". Example: 7 (Birth Date) Allowable Values: 2
CardActivationValidation2 string	Returns the 'Card Activation-SelfService' parameters which is set as '2nd Validation Field' on Product. Valid Values: Refer Appendix s section "Card Activation Validation Parameter". Example: 7 (Birth Date) Allowable Values: 2
CardActivationValidation3 string	Returns the 'Card Activation-SelfService' parameters which is set as '3rd Validation Field' on Product. Valid Values: Refer Appendix s section "Card Activation Validation Parameter". Example: 7 (Birth Date) Allowable Values: 2
CardActivationValidation4 string	Returns the 'Card Activation-SelfService' parameters which is set as '4th Validation Field' on Product. Valid Values: Refer Appendix s section "Card Activation Validation Parameter". Example: 7 (Birth Date) Allowable Values: 2
CardActivationValidation5 string	Returns the 'Card Activation-SelfService' parameters which is set as '5th Validation Field' on Product. Valid Values: Refer Appendix s section "Card Activation Validation Parameter". Example: 7 (Birth Date) Allowable Values: 2
CardActivationValidation6 string	Returns the 'Card Activation-SelfService' parameters which is set as '6th Validation Field' on Product. Valid Values:1-23 Example:14 , New PIN Allowable Values: 2
CardRegistered string	Display whether card is registered or not. Valid Values: 0- Card not registered in Self Service 1- Card registered in Self Service Example: 0 Allowable Values: 0
CardLinked string	Display whether card is linked with any self service user or not. Valid Values: 0- Card not Linked with any Self Service User 1- Card Linked with Self Service User Example: 0 Allowable Values: 0
RegistrationFlag string	Returns whether registraion is allowed for this card or not. Valid Values: Yes or No Example: Yes Allowable Values: 0
CardRegistrationValidation1 string	Returns the 'User Registration' parameters which is set as '1st registration Field' on Product. Allowable Values: 0
CardRegistrationValidation2 string	Returns the 'User Registration' parameters which is set as '2nd registration Field' on Product. Allowable Values: 0
CardRegistrationValidation3 string	Returns the 'User Registration' parameters which is set as '3rd registration Field' on Product. Allowable Values: 0
CardRegistrationValidation4 string	Returns the 'User Registration' parameters which is set as '4th registration Field' on Product. Allowable Values: 0
CardRegistrationValidation5 string	Returns the 'User Registration' parameters which is set as '5th registration Field' on Product. Allowable Values: 0
CardRegistrationValidation6 string	It Returns the 'User Registration' parameters which is set as '6th registration Field' on Product. Allowable Values: 0
CardRegistrationValidation7 string	Returns the 'User Registration' parameters which is set as '7th registration Field' on Product. Allowable Values: 0
CardRegistrationValidation8 string	Returns the 'User Registration' parameters which is set as 8th registration Field' on Product. Allowable Values: 0
CardRegistrationValidation9 string	Returns the 'User Registration' parameters which is set as '9th registration Field' on Product. Allowable Values: 0
CardRegistrationValidation10 string	It Returns the 'User Registration' parameters which is set as '10th registration Field' on Product. Allowable Values: 0
CardRegistrationValidation11 string	Returns the 'User Registration' parameters which is set as '11th registration Field' on Product. Allowable Values: 0
CardRegistrationValidation12 string	Returns the 'User Registration' parameters which is set as '12th registration Field' on Product. Allowable Values: 0
CardRegistrationValidation13 string	Returns the 'User Registration' parameters which is set as '13th registration Field' on Product. Allowable Values: 0
CardRegistrationValidation14 string	Returns the 'User Registration' parameters which is set as '14th registration Field' on Product. Allowable Values: 0
CardRegistrationValidation15 string	Returns the 'User Registration' parameters which is set as '15th registration Field' on Product. Allowable Values: 0
CardActivationValidationDisp1 string	Returns the property in terms of Display/Entry for the 'Card Activation' parameters which is set as '1st Validation Field' on Product. Valid Values: 0=Display 1-Entry
CardActivationValidationDisp2 string	Returns the property in terms of Display/Entry for the 'Card Activation' parameters which is set as '2nd Validation Field' on Product. Valid Values: 0=Display 1-Entry
CardActivationValidationDisp3 string	Returns the property in terms of Display/Entry for the 'Card Activation' parameters which is set as '3rd Validation Field' on Product. Valid Values: 0=Display 1-Entry
CardActivationValidationDisp4 string	Returns the property in terms of Display/Entry for the 'Card Activation' parameters which is set as '4th Validation Field' on Product. Valid Values: 0=Display 1-Entry
CardActivationValidationDisp5 string	Returns the property in terms of Display/Entry for the 'Card Activation' parameters which is set as '5th Validation Field' on Product. Valid Values: 0=Display 1-Entry
CardActivationValidationDisp6 string	Returns the property in terms of Display/Entry for the 'Card Activation' parameters which is set as '6th Validation Field' on Product. Valid Values: 0=Display 1-Entry
CardRegistrationValidationDisp1 string	Returns the property in terms of Mandatory/Optional for the 'User Registration' parameters which is set as '1st registration Field' on Product. Allowable Values: 0
CardRegistrationValidationDisp2 string	Returns the property in terms of Mandatory/Optional for the 'User Registration' parameters which is set as '2nd registration Field' on Product. Allowable Values: 0
CardRegistrationValidationDisp3 string	Returns the property in terms of Mandatory/Optional for the 'User Registration' parameters which is set as '3rd registration Field' on Product. Allowable Values: 0
CardRegistrationValidationDisp4 string	Returns the property in terms of Mandatory/Optional for the 'User Registration' parameters which is set as '4th registration Field' on Product. Allowable Values: 0
CardRegistrationValidationDisp5 string	Returns the property in terms of Mandatory/Optional for the 'User Registration' parameters which is set as '5th registration Field' on Product. Allowable Values: 0
CardRegistrationValidationDisp6 string	Returns the property in terms of Mandatory/Optional for the 'User Registration' parameters which is set as '6th registration Field' on Product. Allowable Values: 0
CardRegistrationValidationDisp7 string	Returns the property in terms of Mandatory/Optional for the 'User Registration' parameters which is set as '7th registration Field' on Product. Allowable Values: 0
CardRegistrationValidationDisp8 string	Returns the property in terms of Mandatory/Optional for the 'User Registration' parameters which is set as '8th registration Field' on Product. Allowable Values: 0
CardRegistrationValidationDisp9 string	Returns the property in terms of Mandatory/Optional for the 'User Registration' parameters which is set as '9th registration Field' on Product. Allowable Values: 0
CardRegistrationValidationDisp10 string	Returns the property in terms of Mandatory/Optional for the 'User Registration' parameters which is set as '10th registration Field' on Product. Allowable Values: 0
CardRegistrationValidationDisp11 string	Returns the property in terms of Mandatory/Optional for the 'User Registration' parameters which is set as '11th registration Field' on Product. Allowable Values: 0
CardRegistrationValidationDisp12 string	Returns the property in terms of Mandatory/Optional for the 'User Registration' parameters which is set as '12th registration Field' on Product. Allowable Values: 0
CardRegistrationValidationDisp13 string	Returns the property in terms of Mandatory/Optional for the 'User Registration' parameters which is set as '13th registration Field' on Product. Allowable Values: 0
CardRegistrationValidationDisp14 string	Returns the property in terms of Mandatory/Optional for the 'User Registration' parameters which is set as '14th registration Field' on Product. Valid Values : 0=Mandatory 1-Optional Allowable Values: 0
CardRegistrationValidationDisp15 string	Returns the 'User Registration' parameters which is set as '15th registration Field' on Product. Allowable Values: 0
RemainingLinkedCardAttempts string	Number of attempts left to link card. Valid Values: 0-9 Example: 4
FlowSessionID string	Reserved for future use
LongFormDisclosureENPDF string	Long form disclosure agreement in English language in PDF format.
LongFormDisclosureESPDF string	Long form disclosure agreement in Spanish language in PDF format.
LongFormDisclosureENJPG string	Long form disclosure agreement in English language in JPG format.
LongFormDisclosureESJPG string	Long form disclosure agreement in Spanish language in JPG format.
ShortFormDisclosureENPDF string	Short form disclosure agreement in English language in PDF format.
ShortFormDisclosureESPDF string	Short form disclosure agreement in Spanish language in PDF format.
ShortFormDisclosureENJPG string	Short form disclosure agreement in English language in JPG format.
ShortFormDisclosureESJPG string	Short form disclosure agreement in Spanish language in JPG format.

Fields

Description

CardActivationValidation1

string

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

Allowable Values:

CardActivationValidation2

string

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

Allowable Values:

CardActivationValidation3

string

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

Allowable Values:

CardActivationValidation4

string

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

Allowable Values:

CardActivationValidation5

string

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

Allowable Values:

CardActivationValidation6

string

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

Allowable Values:

CardRegistered

string

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

Allowable Values:

CardLinked

string

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

Allowable Values:

RegistrationFlag

string

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

Allowable Values:

CardRegistrationValidation1

string

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

Allowable Values:

CardRegistrationValidation2

string

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

Allowable Values:

CardRegistrationValidation3

string

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

Allowable Values:

CardRegistrationValidation4

string

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

Allowable Values:

CardRegistrationValidation5

string

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

Allowable Values:

CardRegistrationValidation6

string

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

Allowable Values:

CardRegistrationValidation7

string

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

Allowable Values:

CardRegistrationValidation8

string

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

Allowable Values:

CardRegistrationValidation9

string

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

Allowable Values:

CardRegistrationValidation10

string

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

Allowable Values:

CardRegistrationValidation11

string

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

Allowable Values:

CardRegistrationValidation12

string

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

Allowable Values:

CardRegistrationValidation13

string

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

Allowable Values:

CardRegistrationValidation14

string

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

Allowable Values:

CardRegistrationValidation15

string

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

Allowable Values:

CardActivationValidationDisp1

string

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

CardActivationValidationDisp2

string

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

CardActivationValidationDisp3

string

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

CardActivationValidationDisp4

string

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

CardActivationValidationDisp5

string

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

CardActivationValidationDisp6

string

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

CardRegistrationValidationDisp1

string

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

Allowable Values:

CardRegistrationValidationDisp2

string

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

Allowable Values:

CardRegistrationValidationDisp3

string

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

Allowable Values:

CardRegistrationValidationDisp4

string

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

Allowable Values:

CardRegistrationValidationDisp5

string

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

Allowable Values:

CardRegistrationValidationDisp6

string

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

Allowable Values:

CardRegistrationValidationDisp7

string

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

Allowable Values:

CardRegistrationValidationDisp8

string

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

Allowable Values:

CardRegistrationValidationDisp9

string

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

Allowable Values:

CardRegistrationValidationDisp10

string

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

Allowable Values:

CardRegistrationValidationDisp11

string

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

Allowable Values:

CardRegistrationValidationDisp12

string

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

Allowable Values:

CardRegistrationValidationDisp13

string

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

Allowable Values:

CardRegistrationValidationDisp14

string

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

Allowable Values:

CardRegistrationValidationDisp15

string

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

Allowable Values:

RemainingLinkedCardAttempts

string

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

FlowSessionID

string

Reserved for future use

LongFormDisclosureENPDF

string

Long form disclosure agreement in English language in PDF format.

LongFormDisclosureESPDF

string

Long form disclosure agreement in Spanish language in PDF format.

LongFormDisclosureENJPG

string

Long form disclosure agreement in English language in JPG format.

LongFormDisclosureESJPG

string

Long form disclosure agreement in Spanish language in JPG format.

ShortFormDisclosureENPDF

string

Short form disclosure agreement in English language in PDF format.

ShortFormDisclosureESPDF

string

Short form disclosure agreement in Spanish language in PDF format.

ShortFormDisclosureENJPG

string

Short form disclosure agreement in English language in JPG format.

ShortFormDisclosureESJPG

string

Short form disclosure agreement in Spanish language in JPG format.

Sample Response Body

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

Card Activation

CardActivation

Request Fields Detail

Sample Request Body

Response Fields Detail

Sample Response Body

ValidateCardActivation

Request Fields Detail

Sample Request Body

Response Fields Detail

Sample Response Body

Card Management

Card Management

Card Management

Card Management

Card Management

Card Activation

Card Activation

Card Activation

Card Activation

Card Activation