Category links

API Links

Account Holder

The Account Holder is the individual who has an account in the CoreCard system. You can use CoreCard APIs to create an account. An Account holder in CoreCard is also called a Primary Account Holder i.e. the main account holder who is the sole owner of the account and has the rights to modify account-related attributes.

CoreCard stores personal identification information (PII) data, levels of control & specific configuration for all account holders.

A card account can also be used by the secondary cardholder, and a primary cardholder can limit the usage of available funds and also account-related rights and activities for the secondary cardholder.

A card is created under an account that holds all card-related attributes which can be used at different merchant/ATM locations as well as online stores.

AccountCreation

Action: POST

Endpoint: /api/AccountCreation

POST /api/AccountCreation

Use this API to create account in the CoreCARD platform. New accounts are created for a specific product . The API captures required personal information for the account holder , including address and shipping information.

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

AccountCreationMethod

string

Mandatory

Indicates the account creation methods. There are 2 methods for account creation. This tag value is not considered for the multi wallet products. Valid values : 0= With Load 1= Without Load

Allowable Values:

1

BranchCode

string

Mandatory

Branch code from where the card was issued. Valid Values:0-9 Example:1006

Allowable Values:

50

ProductID

string

Mandatory

ID of the Account's Product Valid Values:0-9 Example:1511

Allowable Values:

10

LinkWithExistingAccountFlag

string

Optional

Flag to link with existing Account Number. Valid Values: 0 = No 1 = Yes Example: 1

Allowable Values:

1

LinkedAccountNumber

string

Conditional

To link an account with an existing account in the system. Valid values : Existing Account Number Example : 60000000009719

Allowable Values:

19

LoadAmount

decimal

Conditional

Use to post the amount of Load on the cardholder account. Valid Values: 0-9 Format: XXX.XX Example: 100.50 Condition: It is mandatory when AccountCreationMethod tag is '0' (With Load). Additionally for the multi wallet products, this tag will be bypassed.

Title

string

Optional

Title for the customer Valid Values: Refer Appendix Section : Title Values Example: Mr.

Allowable Values:

9

FirstName

string

Mandatory

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

Allowable Values:

50

MiddleName

string

Optional

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

Allowable Values:

50

LastName

string

Mandatory

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

Allowable Values:

50

NameOnCard

string

Mandatory

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

Allowable Values:

28

DateOfBirth

datetime

Conditional

Date of Birth of cardholder Format: MM/DD/YYYY Valid Values: 0-9 Example:- 03/26/1986 Condition: It is Mandatory when Card Account Parameters is Set as Yes on Product.

AddressLine1

string

Mandatory

Address Line 1 of the Cardholder Valid values : 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

Country

string

Mandatory

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

Allowable Values:

2

State

string

Mandatory

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

Allowable Values:

3

City

string

Mandatory

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

Allowable Values:

25

PostalCode

string

Mandatory

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

Allowable Values:

10

DifferentShipToAddress

string

Mandatory

Decision flag to decides address to ship a card. Valid Values: 0 = Ship To Card holder Address 1 = Ship To Office Address 2 = Ship To Other Address Example: 2

Allowable Values:

2

ShipToFirstName

string

Conditional

First Name for Shipping address Valid Values: A-Z,a-z. Example: TestName Condition :It is mandatory when DifferentShipToAddress =2

Allowable Values:

50

ShipToMiddleName

string

Optional

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

Allowable Values:

50

ShipToLastName

string

Conditional

Last Name for Shipping address Valid Values: A-Z,a-z. Example: LastName Condition :It is mandatory when DifferentShipToAddress =2

Allowable Values:

50

ShipToAddressLine1

string

Conditional

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

Allowable Values:

50

ShipToAddressLine2

string

Optional

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

Allowable Values:

50

ShipToCity

string

Conditional

City for Shipping address Valid values:A-Z, a-z, 0-9 Example:Norcross Condition :It is mandatory when DifferentShipToAddress =2

Allowable Values:

25

ShipToPostalCode

string

Conditional

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

Allowable Values:

10

ShipToCountry

string

Conditional

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

Allowable Values:

2

ShipToState

string

Conditional

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

Allowable Values:

3

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

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:

100

SocialSecurityNumber

string

Conditional

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

Allowable Values:

9

IDName

string

Mandatory

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

Allowable Values:

2

IDNumber

string

Conditional

Last 4 Digits of Primary ID Valid Values: 0-9 Example: 4586 Condition: This field is mandatory when IDName = '01','02','03','04','05','06','07','08','09','10','12','13'.

Allowable Values:

18

IDDescription

string

Conditional

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

Allowable Values:

20

IDIssueCountry

string

Conditional

ID Issuing Country Valid values :A-Z, a-z Example: US Condition : Mandatory when IDName in (2,3,4,5,6,7,8,9,10,12,13) Appendix Section:Refer Appendix Section : Country Code Values

Allowable Values:

2

IDIssueState

string

Conditional

ID Issue State Valid Values:A-Z,a-z Example:GA Condition:This field is mandatory when IDName = '02', '07' and Country = US Appendix Section: Refer Appendix Section : State Codes (US)

Allowable Values:

3

IDIssueDate

datetime

Conditional

ID Issue Date Format: MM/DD/YYYY Valid Values:0-9 Example: 03/26/1998 Condition: This field is mandatory when IDName= '02' and IDIssueCountry = 'US' and IDIssueState is other than 'MA','MO','MI','TX'

IDExpirationDate

datetime

Optional

Expiration date of ID. Format: MM/DD/YYYY Valid Values:0-9 Example:03/26/1998

HomePhoneNumber

string

Conditional

Home Phone Number. Valid Values: 0-9 Example: 9812338769 Condition: It is Mandatory when Card Account Parameters is Set as Yes on Product. Note: At least one of HomePhoneNumber, WorkPhoneNumber or MobilePhoneNumber tag is needed when Phone number required is set as ‘Yes’.

Allowable Values:

10

WorkPhoneNumber

string

Conditional

Cardholder Work Phone Number Valid values:0-9 Example:9632581470 Condition: It is Mandatory when Card Account Parameters is Set as Yes on Product. Note: At least one of HomePhoneNumber, WorkPhoneNumber or MobilePhoneNumber tag is needed when Phone number required is set as ‘Yes’.

Allowable Values:

10

MobilePhoneNumber

string

Conditional

Cardholder's Mobile Phone Number Valid Values: 0-9 Example: 9876543210 Condition: It is Mandatory when Card Account Parameters is Set as Yes on Product. Note: At least one of HomePhoneNumber, WorkPhoneNumber or MobilePhoneNumber tag is needed when Phone number required is set as ‘Yes’.

Allowable Values:

10

HomeFaxNumber

string

Optional

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

Allowable Values:

10

WorkFaxNumber

string

Optional

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

Allowable Values:

10

IsCardMasked

string

Optional

Flag to indicate CardNumber should be returned in masked form or in clear form. Valid Values: 0= Card Number without Masked in Resonse. 1= Card Number with Masked in Resonse. 2= No Card Number in Resonse. Note : Default value is 0

Allowable Values:

1

CreateCIPFailedAccount

string

Optional

Action to be taken when CIP check is failed Possible value are 'Y' and 'N' Y- Create Account N- Do not create Account

Allowable Values:

1

AddAndLoadWalletDetails

array

Optional

LinkWithExistingCustomer

Int32

Optional

To link new account with existing customer using customer ID Valid Values: 0 = No(default) and 1 = Yes Format: x Example: 0=No,

CustomerID

string

Conditional

Unique ID associated with Customer Valid Values: 0-9 a-z Format: xxxx Example: abc2123 Condition: Mandatory when 'Link With Existing Customer' = Yes

Allowable Values:

25

HoldEmbossing

Int32

Optional

Tag to decide physical card or virtual card by holding embossing file. Valid Values: 0 - No (Physical card) 1 - Yes (Virtual card)

Sample Request Body 
{
  "APIVersion": "1.4",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "AccountCreationMethod": "0",
  "BranchCode": "CC10000",
  "ProductID": "1739",
  "LinkWithExistingAccountFlag": "",
  "LinkedAccountNumber": "",
  "LoadAmount": 200.01,
  "Title": "01",
  "FirstName": "Harshal",
  "MiddleName": "",
  "LastName": "Waje",
  "NameOnCard": "Harshal Waje",
  "DateOfBirth": "1995-05-17T00:00:00",
  "AddressLine1": "kush",
  "AddressLine2": "V Time Square",
  "Country": "US",
  "State": "DC",
  "City": "Navi Mumbai",
  "PostalCode": "40061",
  "DifferentShipToAddress": "1",
  "ShipToFirstName": "Harshal",
  "ShipToMiddleName": "",
  "ShipToLastName": "Waje",
  "ShipToAddressLine1": "kush",
  "ShipToAddressLine2": "V Time Square",
  "ShipToCity": "Navi Mumbai",
  "ShipToPostalCode": "40061",
  "ShipToCountry": "US",
  "ShipToState": "DC",
  "EmailAddress1": "harshal.waje@corecard.com",
  "EmailAddress2": "harshal.waje8@corecard.com",
  "SocialSecurityNumber": "587987851",
  "IDName": "02",
  "IDNumber": "12587",
  "IDDescription": "",
  "IDIssueCountry": "US",
  "IDIssueState": "ID",
  "IDIssueDate": "2017-05-17T00:00:00",
  "IDExpirationDate": "2024-12-24T00:00:00",
  "HomePhoneNumber": "2158795878",
  "WorkPhoneNumber": "2587958789",
  "MobilePhoneNumber": "5879878965",
  "IsCardMasked": "",
  "CreateCIPFailedAccount": "Y",
  "AddAndLoadWalletDetails": [
    {
      "WalletID": 1001,
      "WalletLoadAmount": 20.0
    }
  ],
  "LinkWithExistingCustomer": 1,
  "CustomerID": "1031716",
  "HoldEmbossing": 1
}
Response Fields Detail
Fields Description

AccountNumber

string

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

ProxyNumber

string

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

CardNumber

string

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

DDANumber

string

DDA (Direct Deposit Account) which can be used in ACH transactions. Valid values : 0-9 Example:1234567890

ABANumber

string

Destination Routing and Transit number of institution.

UserID

string

UserID Example:AdminUser

DerivedStatus

string

Status which is derived by considering Card Status (manual and generated), account status (manual and generated) and Card plastic status Example: Active

CardExpirationDate

datetime

Expiration Date of the card. Format: yyyy-mm-ddThh:mm:ss Valid Values: 0-9,'/'. Example: 2021-09-26T00:00:00

CVC

string

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

CardExpirationDateISO

string

Expiration Date of created card as per ISO format. Format: MMYY Example: 0121

CustomerID

string

Unique ID associated with Customer Valid Values: 0-9 a-z Format: xxxx Example: abc2123

LNResultsGroup

LNResultsGroup

NASCheckValue

string

Name Address SSN (NAS) Check tag shows Reason Codes which is being triggered on the card Example: 10 Input First name, Address, and SSN matched

LexNexList

array

This will have RiskCodes in Array

CVICheckValue

string

score of Comprehensive Verification Index Example: 0,10,20

OFACResultsGroup

OFACResultsGroup

Sample Response Body 

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {
    "AccountNumber": "60000000032695",
    "ProxyNumber": "1316770",
    "CardNumber": "406684******3031",
    "DDANumber": "3216120013031",
    "ABANumber": "061000146",
    "UserID": "ccadminapi",
    "DerivedStatus": "",
    "CardExpirationDate": "2024-08-31T00:00:00",
    "CVC": "",
    "CardExpirationDateISO": "0425",
    "CustomerID": "1031716",
    "LNResultsGroup": {
      "LexNexList": [
        {
          "RiskCodes": "11: The input address may be invalid according to postal specifications"
        }
      ],
      "CVICheckValue": "10",
      "NASCheckValue": "4",
      "LexNexInquiryDate": "2024-08-31T00:00:00"
    },
    "OFACResultsGroup": {
      "OFACInquiryDate": "2024-08-31T00:00:00",
      "OFACScore": "10",
      "SDNEntry1": "83",
      "SDNEntry2": "83",
      "SDNEntry3": "83",
      "SDNEntry4": "83",
      "SDNEntry5": "83"
    }
  }
}

CardPersonalization

Action: POST

Endpoint: /api/CardPersonalization

POST /api/CardPersonalization

Use this API to Request a Personalized Card.

Request Fields Detail
Fields Description

APIVersion

string

Mandatory

Version of the API to be invoked Example: 1.3

Allowable Values:

10

IPAddress

string

Mandatory

IP Address of sender Example: 10.206.0.204

Allowable Values:

15

Source

string

Mandatory

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

Allowable Values:

50

CallerID

string

Optional

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

Allowable Values:

20

CalledID

string

Optional

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

Allowable Values:

20

SessionID

string

Optional

Reserved for future use

Allowable Values:

50

ANI

string

Optional

Reserved for future use

Allowable Values:

0

DNS

string

Optional

Reserved for future use

Allowable Values:

0

Language

string

Optional

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

Allowable Values:

2

RequestDate

string

Optional

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

Allowable Values:

19

CardNumber

string

Conditional

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

Allowable Values:

16

ProxyNumber

string

Conditional

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

Allowable Values:

19

DecisionFlag

string

Mandatory

Decision Flag. Valid Values: 1.To Replace of card from self service. 2.To send Shipping address information of card Example : 1

Allowable Values:

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

NameOnCard

string

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

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

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

City

string

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

PostalCode

string

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

State

string

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

Country

string

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

Sample Response Body 

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {
    "NameOnCard": "CHRISTOPHER BOLLMAN",
    "FirstName": "CHRISTOPHER",
    "MiddleName": "",
    "LastName": "BOLLMAN",
    "AddressLine1": "23 PLANT LN",
    "AddressLine2": "",
    "City": "LA MESA",
    "PostalCode": "91942",
    "State": "CA",
    "Country": "US"
  }
}

CreateSavingAccount

Action: POST

Endpoint: /api/CreateSavingAccount

POST /api/CreateSavingAccount

Use this API to create savings account linked to prepaid card account available in system. Saving account can be used to deposit and withdraw funds however those funds cannot be used to fulfill scheme transactions. Saving account balance is maintained separate from prepaid account balance.

Request Fields Detail
Fields Description

APIVersion

string

Mandatory

Version of the API to be invoked Example: 1.3

Allowable Values:

10

IPAddress

string

Mandatory

IP Address of sender Example: 10.206.0.204

Allowable Values:

15

Source

string

Mandatory

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

Allowable Values:

50

CallerID

string

Optional

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

Allowable Values:

20

CalledID

string

Optional

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

Allowable Values:

20

SessionID

string

Optional

Reserved for future use

Allowable Values:

50

ANI

string

Optional

Reserved for future use

Allowable Values:

0

DNS

string

Optional

Reserved for future use

Allowable Values:

0

Language

string

Optional

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

Allowable Values:

2

RequestDate

string

Optional

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

Allowable Values:

19

CardNumber

string

Conditional

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

Allowable Values:

16

ProxyNumber

string

Conditional

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

Allowable Values:

19

AccountNumber

string

Conditional

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

Allowable Values:

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

SavingAccountNumber

string

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

Allowable Values:

19

SavingAccountDDANumber

string

Saving Account DDA Number (Direct Deposit Account) which can be used in ACH transactions. Valid values : 0-9 Example:1234567890

SavingAccountProxyNumber

string

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

Sample Response Body 

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {
    "SavingAccountNumber": "60000000032588",
    "SavingAccountDDANumber": "0040000000798",
    "SavingAccountProxyNumber": "1376862"
  }
}

CreateSecondaryCard

Action: POST

Endpoint: /api/CreateSecondaryCard

POST /api/CreateSecondaryCard

Use this API to create a secondary or virtual card in a single step. Certain information is required depending upon the card type, such as cardholder details, a shipping address, and card expiry date (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

AccountNumber

string

Conditional

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

Allowable Values:

19

ProxyNumber

string

Conditional

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

Allowable Values:

19

CardNumber

string

Conditional

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

Allowable Values:

16

Title

string

Optional

Title for the customer Valid Values: Refer Appendix Section : Title Values Example: Mr.

Allowable Values:

9

FirstName

string

Mandatory

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

Allowable Values:

50

MiddleName

string

Optional

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

Allowable Values:

50

LastName

string

Mandatory

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

Allowable Values:

50

DOB

datetime

Mandatory

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

AddressLine1

string

Mandatory

Address Line 1 of the Cardholder Valid values : 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

City

string

Mandatory

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

Allowable Values:

25

Country

string

Mandatory

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

Allowable Values:

2

PostalCode

string

Mandatory

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

Allowable Values:

10

State

string

Mandatory

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

Allowable Values:

3

HomePhoneNumber

string

Conditional

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

Allowable Values:

10

WorkPhoneNumber

string

Conditional

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

Allowable Values:

10

MobilePhoneNumber

string

Conditional

Cardholder's Mobile Phone Number Valid Values: 0-9 Example: 9876543210 Condition:If validation parameter set on product as Work Phone)

Allowable Values:

10

EmailID

string

Conditional

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

Allowable Values:

100

SocialSecurityNumber

string

Mandatory

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

Allowable Values:

9

IDNumber

string

Mandatory

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

Allowable Values:

18

MotherMaidenName

string

Optional

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

Allowable Values:

40

IDTypeCode

string

Conditional

Identification Type Code Valid Values: 02- Driver’s license 03- Matricular 04- Passport 05- Visa 06- Green Card 07- State ID 08- Military ID 09- Voters Registration Card 10- government ID 11- Tax identification number 12 - Cedula ID Example:05

Allowable Values:

2

IDIssueDate

datetime

Conditional

ID Issue Date Format: MM/DD/YYYY Valid Values:0-9 Example: 03/26/1998 Condition: This field is mandatory when IDTypeCode is "2".

IDExpirationDate

datetime

Conditional

Expiration date of ID. Format: MM/DD/YYYY Valid Values:0-9 Example:03/26/1998

IDIssueState

string

Conditional

ID Issue State Valid Values:A-Z,a-z Example:GA Refer Appendix section : State Codes (US) Condition: This field is mandatory when IDIssuingAuthority = 'US',IDTypeCode = '07' or IDTypeCode='02'.

Allowable Values:

3

NameOnCard

string

Mandatory

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

Allowable Values:

28

EmbossingLine4

string

Optional

Embossing line4.

Allowable Values:

26

ClientID

string

Optional

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

Allowable Values:

50

VirtualCardExpiryOption

string

Conditional

Virtual Card Expiry Option Valid values are 0,1,2 0 = Card will expire after n number of transaction 1 = Card will expire after n number of days/hour/Minutes/Month/Weeks/years 2 = Card will expire on particular date Condition : SecondaryCardType = 1 then this options will be applicable.

Allowable Values:

50

LanguageIndicator

string

Optional

Language Indicator Valid Values:A-Z,a-z. Example: en, where en represents 'English'

Allowable Values:

10

SecondaryCardType

string

Mandatory

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

Allowable Values:

5

IssuanceCardType

Int32

Optional

Secondary card type Valid Values : Blank = New card created (Default value) 2 = Issue from Inventory (Future use) Example : 2

SecondaryCardNumber

string

Conditional

Card number of the card from inventory Valid values: 0-9 Example: 123456******0001 Condition: This field is mandatory when IssuanceCardType is 2(Issue from Inventory).

Allowable Values:

16

SecondaryProxyNumber

string

Conditional

Proxy number of the card from inventory Valid values:0-9 Example:1005 Condition: This field is mandatory when IssuanceCardType is 2(Issue from Inventory).

Allowable Values:

19

VirtualCardLimit

string

Conditional

Virtual Card Limit allocates for Virtual Card it can be greater than available balance of primary card but can not be greater than the primary card limit which is set on product. Condition : SecondaryCardType = 1 then this options will be applicable Example 100,200 When SecondaryCardType = 2, then it will display the Family Card Usage Limit

Allowable Values:

11

VirtualCardResetAllow

string

Conditional

Virtual Card Reset Allowed or not Valid Values 0:Yes, 1 : No Example : 1 Condition: This field is mandatory when SecondaryCardType is 1(Virtual Card).

Allowable Values:

5

VirtualCardExpiresNumberOfTransaction

string

Conditional

Number of transaction allowed from the virtual card Valid Values : 0-9 Example : 10 Condition : Mandatory When VirtualCardExpiryOption = 0

Allowable Values:

4

VirtualCardExpiryDuration

string

Conditional

Duration Valid Values are 0 = Minutes 1 = Hour 2 = Day 3 = Week 4 = Month 5 = Year Example : 3 Condition:Mandatory When VirtualCardExpiryOption is 1

Allowable Values:

5

VirtualCardExpiresExpiryDate

string

Conditional

Date of expiration for virtual card Format: mmddyyyy Condition : Mandatory When VirtualCardExpiryOption is 2.

Allowable Values:

8

VirtualCardExpiryValue

string

Conditional

Duration Valid Values : 1-999 Condition: Mandatory When VirtualCardExpiryOption = 1

Allowable Values:

5

IDIssuingAuthority

string

Conditional

ID Issuing Authority (country) Condition : This field is mandatory when IDName is provided. Example : AE = United Arab Emirates

Allowable Values:

5

CIPCheck

string

Optional

CIP check for secondary card Should be performed or not. Valid Values: 0 (No) 1 (Yes) Condition: 1 should only be accepted when on product 'CIP/LN checkfor Secondary Card' is YES. By default it should go as 1 (Yes)

Allowable Values:

2

RelationwithPrimary

string

Optional

RelationwithPrimary card holder Valid Values: 0=Wife, 1=Husband, 2=Son, 3=Daughter, 4=Brother, 5=Sister, 6=Father, 7=Mother, 8=Partner, 9=Other.

Allowable Values:

2

CreateCIPFailedAccount

string

Optional

Action to be taken when CIP check is failed Possible value are 'Y' and 'N' Y- Create Account N- Do not create Account

Allowable Values:

1

LinkWithExistingCustomer

Int32

Optional

To link new account with existing customer using customer ID Valid Values: 0 = No(default) and 1 = Yes Format: x Example: 0=No,

CustomerID

string

Conditional

Unique ID associated with Customer Valid Values: 0-9 a-z Format: xxxx Example: abc2123 Condition: Mandatory when 'Link With Existing Customer' = Yes

Allowable Values:

25

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

Allowable Values:

1

HoldEmbossing

Int32

Optional

Tag to decide physical card or virtual card by holding embossing file. Valid Values: 0 - No (Physical card) 1 - Yes (Virtual card)

Sample Request Body 
{
  "APIVersion": "1.5",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "AccountNumber": "",
  "ProxyNumber": "1316614",
  "CardNumber": "",
  "Title": "DR.",
  "FirstName": "Sanjay",
  "MiddleName": "",
  "LastName": "V",
  "DOB": "1986-03-26T00:00:00",
  "AddressLine1": "add1",
  "AddressLine2": "add2",
  "City": "fsf",
  "Country": "US",
  "PostalCode": "98767",
  "State": "GA",
  "HomePhoneNumber": "",
  "WorkPhoneNumber": "",
  "MobilePhoneNumber": "9896767678",
  "EmailID": "sanjay@ss.com",
  "SocialSecurityNumber": "111111111",
  "IDNumber": "",
  "MotherMaidenName": "",
  "IDTypeCode": "02",
  "IDIssueDate": "2017-05-17T00:00:00",
  "IDExpirationDate": "2024-12-24T00:00:00",
  "IDIssueState": "SA",
  "NameOnCard": "Sanjay V",
  "EmbossingLine4": "",
  "ClientID": "",
  "VirtualCardExpiryOption": "0",
  "LanguageIndicator": "",
  "SecondaryCardType": "0",
  "IssuanceCardType": 0,
  "SecondaryCardNumber": "",
  "SecondaryProxyNumber": "",
  "VirtualCardLimit": "",
  "VirtualCardResetAllow": "",
  "VirtualCardExpiresNumberOfTransaction": "",
  "VirtualCardExpiryDuration": "",
  "VirtualCardExpiresExpiryDate": "",
  "VirtualCardExpiryValue": "",
  "IDIssuingAuthority": "AU",
  "CIPCheck": "",
  "RelationwithPrimary": "",
  "CreateCIPFailedAccount": "Y",
  "LinkWithExistingCustomer": 1,
  "CustomerID": "1031716",
  "IsCardMasked": "1",
  "HoldEmbossing": 1
}
Response Fields Detail
Fields Description

AccountNumber

string

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

FirstName

string

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

LastName

string

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

CardStatus

string

Card Plastic Status Example : New Card Pending Activation

ValidFrom

string

Card Creation Date of requested card. Format:MM/YY Example:03/21

ValidTo

string

Card Expiration Date of requested card. Format:MM/dd/yyyy HH:mm:ss Example:01/01/2022

CurrentCardBalance

decimal

Current Balance of Account Example: 5425.00

ActivationRequired

string

Activation required or not. Valid Values : Yes , No Example : Yes

NameOnCard

string

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

ProxyNumber

string

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

CloseDate

datetime

Close or cancellation Date of requested card. Format: yyyy-mm-ddThh:mm:ss Example: 2017-09-26T00:00:00

CardExpirationDate

datetime

Expiration Date of the card. Format: yyyy-mm-ddThh:mm:ss Valid Values: 0-9 Example: 2021-09-26T00:00:00

CardExpirationDateISO

string

Expiration Date of created card as per ISO format. Format: MMYY Example: 0121

CustomerID

string

Unique ID linked to the customer Valid Values:0-9 Example: 3212212

SecondaryCardType

string

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

CardGeneratedStatus

string

Generated Status of Card Example :New Card Pending Activation

CVC

string

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

LNResultsGroup

LNResultsGroup

RequestedProxyNumber

string

Proxy number of the card which requested the secondary card Valid values:0-9 Example:100556

CardNumber

string

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

OFACResultsGroup

OFACResultsGroup

Sample Response Body 

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {
    "AccountNumber": "60000000031747",
    "CardNumber": "4066846120022456",
    "FirstName": "Sanjay",
    "LastName": "V",
    "CardStatus": "INACTIVE",
    "ValidFrom": "12/20",
    "CurrentCardBalance": 250.0,
    "ActivationRequired": "YES",
    "NameOnCard": "Sanjay V",
    "ProxyNumber": "1316750",
    "CloseDate": "2024-10-24T00:00:00",
    "CardExpirationDate": "2024-10-24T00:00:00",
    "CardExpirationDateISO": "0425",
    "CustomerID": "1031716",
    "SecondaryCardType": "",
    "CardGeneratedStatus": "",
    "CVC": "",
    "LNResultsGroup": {
      "LexNexList": [
        {
          "RiskCodes": "11: The input address may be invalid according to postal specifications"
        }
      ],
      "CVICheckValue": "10",
      "NASCheckValue": "4",
      "LexNexInquiryDate": "2024-08-31T00:00:00"
    },
    "OFACResultsGroup": {
      "OFACInquiryDate": "2024-08-31T00:00:00",
      "OFACScore": "10",
      "SDNEntry1": "83",
      "SDNEntry2": "83",
      "SDNEntry3": "83",
      "SDNEntry4": "83",
      "SDNEntry5": "83"
    }
  }
}

PersonalizeCard

Action: POST

Endpoint: /api/PersonalizeCard

POST /api/PersonalizeCard

With the inventory of preprinted cards, a User may send a post request with card number, account number, or admin number along with the customer PII data, address information, ID, and other required details to update a card account's customer records and register it with the customer. This allows a customer to instantly receive a card.

Request Fields Detail
Fields Description

APIVersion

string

Mandatory

Version of the API to be invoked Example: 1.3

Allowable Values:

10

IPAddress

string

Mandatory

IP Address of sender Example: 10.206.0.204

Allowable Values:

15

Source

string

Mandatory

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

Allowable Values:

50

CallerID

string

Optional

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

Allowable Values:

20

CalledID

string

Optional

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

Allowable Values:

20

SessionID

string

Optional

Reserved for future use

Allowable Values:

50

ANI

string

Optional

Reserved for future use

Allowable Values:

0

DNS

string

Optional

Reserved for future use

Allowable Values:

0

Language

string

Optional

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

Allowable Values:

2

RequestDate

string

Optional

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

Allowable Values:

19

CardNumber

string

Conditional

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

Allowable Values:

16

ProxyNumber

string

Conditional

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

Allowable Values:

19

Title

string

Optional

Title for the customer Valid Values: Refer Appendix Section : Title Values Example: Mr.

Allowable Values:

9

FirstName

string

Mandatory

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

Allowable Values:

50

MiddleName

string

Optional

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

Allowable Values:

50

LastName

string

Mandatory

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

Allowable Values:

50

SecondLastName

string

Optional

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

Allowable Values:

40

NameOnCard

string

Mandatory

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

Allowable Values:

28

DateOfBirth

datetime

Mandatory

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

MotherMaidenName

string

Optional

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

Allowable Values:

40

CustomAccountID

string

Optional

Any custom ID which is used to uniquely identify the Account. Valid values: A-Z, a-z, 0-9 Example:123456789

Allowable Values:

25

AddressLine1

string

Mandatory

Address Line 1 of the Cardholder Valid values : 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

Country

string

Mandatory

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

Allowable Values:

2

State

string

Mandatory

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

Allowable Values:

3

City

string

Mandatory

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

Allowable Values:

25

PostalCode

string

Mandatory

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

Allowable Values:

10

HomePhoneCountryCode

Int32

Optional

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

HomePhoneNumber

string

Conditional

Home Phone Number. Valid Values: 0-9 Example: 9812338769 Condition: Mandatory when WorkPhoneNumber or MobilePhoneNumber not provided

Allowable Values:

10

HomePhoneExtension

Int32

Optional

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

WorkPhoneCountryCode

Int32

Optional

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

WorkPhoneNumber

string

Conditional

Cardholder Work Phone Number Valid values:0-9 Example:9632581470 Condition:Mandatory when HomePhoneNumber or MobilePhoneNumber not provided

Allowable Values:

10

WorkPhoneExtension

Int32

Optional

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

MobilePhoneNumber

string

Conditional

Cardholder's Mobile Phone Number Valid Values: 0-9 Example: 9876543210 Condition: Mandatory when HomePhoneNumber or WorkPhoneNumber not provided

Allowable Values:

10

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

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:

100

SocialSecurityNumber

string

Mandatory

Social Security Number of Cardholder Valid Values:0-9 Example:123456789 Condition:At least one of SocialSecurityNumber or IDName field should be passed in the input as Identification details.

Allowable Values:

9

IDName

string

Conditional

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

Allowable Values:

2

IDNumber

string

Conditional

Last 4 Digits of Primary ID Valid Values: 0-9 Example: 4586 Condition : This field is mandatory when IDName is provided.

Allowable Values:

18

IDDescription

string

Conditional

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

Allowable Values:

20

IDIssuingAuthority

string

Conditional

ID Issuing Authority (country) Example : AE = United Arab Emirates Condition : This field is mandatory when IDName is provided.

Allowable Values:

5

IDIssueState

string

Conditional

ID Issue State Valid Values:A-Z,a-z Example:GA Appendix Section: Refer Appendix Section : State Codes (US) Condition : Mandatory when IDName is 07 and IDIssuingAuthority is US

Allowable Values:

3

IDIssueDate

datetime

Conditional

ID Issue Date Format: MM/DD/YYYY Valid Values:0-9 Example: 03/26/1998 Condition : Mandatory when IDName is 02

IDExpirationDate

datetime

Conditional

Expiration date of ID. Format: MM/DD/YYYY Valid Values:0-9 Example:03/26/1998 Condition : Mandatory when IDName is 02

ShipToAddress

string

Optional

Decision flag to decides address to ship a card. Valid Values: 2 : Same as Physical Primary Address 3 : Ship to Other Address Example: 2

Allowable Values:

2

ShipToFirstName

string

Conditional

First Name for Shipping address Valid Values: A-Z,a-z. Example: TestName Condition : mandatory when ShipToAddress is 2 or 3

Allowable Values:

50

ShipToMiddleName

string

Optional

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

Allowable Values:

50

ShipToLastName

string

Conditional

Last Name for Shipping address Valid Values: A-Z,a-z. Example: LastName Condition: mandatory when ShipToAddress is 2 or 3

Allowable Values:

50

ShipToAddressLine1

string

Conditional

Address Line 1 for Shipping address Valid values:A-Z, a-z, 0-9 Example: 1 Meca Way Condition: mandatory when ShipToAddress is 2 or 3

Allowable Values:

50

ShipToAddressLine2

string

Optional

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

Allowable Values:

50

ShipToCity

string

Conditional

City for Shipping address Valid values:A-Z, a-z, 0-9 Example:Norcross Condition: mandatory when ShipToAddress is 2 or 3

Allowable Values:

25

ShipToState

string

Conditional

State for Shipping address Valid Values:A-Z,a-z Example:NY Refer Appendix section : State Codes (US) Condition: mandatory when ShipToAddress is 2 or 3

Allowable Values:

3

ShipToCountry

string

Conditional

Country Code for Shipping address Valid values are A-Z, a-z Example: US Refer Appendix section : Country Code Values Condition: mandatory when ShipToAddress is 2 or 3

Allowable Values:

2

ShipToPostalCode

string

Conditional

ZIP code for Shipping address Valid values:A-Z, a-z,0-9 Example: 30093 Condition: mandatory when ShipToAddress is 2 or 3

Allowable Values:

10

UserFieldTitle1

string

Optional

Field to capture additional data from cardholder as per product setup Format in case of date: MMDDYYYY Valid Values:A-Z,a-z,0-9 Example: Test,1234,09102019

Allowable Values:

40

UserFieldTitle2

string

Optional

Field to capture additional data from cardholder as per product setup Format in case of date: MMDDYYYY Valid Values:A-Z,a-z,0-9 Example: company

Allowable Values:

40

UserFieldTitle3

string

Optional

Field to capture additional data from cardholder as per product setup Format in case of date: MMDDYYYY Valid Values:A-Z,a-z,0-9 Example: company

Allowable Values:

40

UserFieldTitle4

string

Optional

Field to capture additional data from cardholder as per product setup Format in case of date: MMDDYYYY Valid Values:A-Z,a-z,0-9 Example: company

Allowable Values:

40

UserFieldTitle5

string

Optional

Field to capture additional data from cardholder as per product setup Format in case of date: MMDDYYYY Valid Values:A-Z,a-z,0-9 Example: company

Allowable Values:

40

CIPCheckConducted

string

Optional

CIP Check is conducted on the card or not. Valid Values: 0 = Yes 1 = No Example : 1

Allowable Values:

1

GeneratePlastic

byte

Optional

Flag to decide new plastic card number. Valid values: 0=Generates Additional card(Same Cardnumber), 1= Generates a new Card(Different Cardnumber). Condition: works after product configuration

IsCardMasked

string

Optional

Flag to indicate CardNumber should be returned in masked form or in clear form. Valid Values: 0= Card Number without Masked in Resonse. 1= Card Number with Masked in Resonse. 2= No Card Number in Resonse. Note : Default value is 0

Allowable Values:

1

LinkedAccountNumber

string

Optional

To link an account with an existing account in the system. Valid values : Existing Account Number Example : 60000000009719

Allowable Values:

19

APIFunction

string

Conditional

Status of card during LN/OFAC check Valid Values : 0 = Normal Sell / PersonaliseCard 1 = Sell / Personalise Card from release approve panel Example: 1

Allowable Values:

1

AddAndLoadWalletDetails

array

Optional

LinkWithExistingCustomer

Int32

Optional

To link new account with existing customer using customer ID Valid Values: 0 = No(default) and 1 = Yes Format: x Example: 0=No,

CustomerID

string

Conditional

Unique ID associated with Customer Valid Values: 0-9 a-z Format: xxxx Example: abc2123 Condition: Mandatory when 'Link With Existing Customer' = Yes

Allowable Values:

25
Sample Request Body 
{
  "APIVersion": "1.4",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "CardNumber": "4066836120006077",
  "ProxyNumber": "",
  "Title": "",
  "FirstName": "Mark",
  "MiddleName": "",
  "LastName": "smith",
  "SecondLastName": "",
  "NameOnCard": "",
  "DateOfBirth": "1986-03-26T00:00:00",
  "MotherMaidenName": "",
  "CustomAccountID": "",
  "AddressLine1": "AB",
  "AddressLine2": "CD",
  "Country": "US",
  "State": "GA",
  "City": "NoCross",
  "PostalCode": "34351",
  "HomePhoneCountryCode": 0,
  "HomePhoneNumber": "2569859685",
  "HomePhoneExtension": 0,
  "WorkPhoneCountryCode": 0,
  "WorkPhoneNumber": "2569859682",
  "WorkPhoneExtension": 0,
  "MobilePhoneNumber": "2569859681",
  "EmailAddress1": "harshalwaje8@mail.com",
  "EmailAddress2": "",
  "SocialSecurityNumber": "458968579",
  "IDName": "",
  "IDNumber": "",
  "IDDescription": "",
  "IDIssuingAuthority": "",
  "IDIssueState": "",
  "IDIssueDate": "2017-11-22T00:00:00",
  "IDExpirationDate": "2024-10-22T00:00:00",
  "ShipToAddress": "2",
  "ShipToFirstName": "Mark",
  "ShipToMiddleName": "",
  "ShipToLastName": "smith",
  "ShipToAddressLine1": "51 Cross Dew",
  "ShipToAddressLine2": "",
  "ShipToCity": "NoCross",
  "ShipToState": "GA",
  "ShipToCountry": "US",
  "ShipToPostalCode": "34567",
  "UserFieldTitle1": "",
  "UserFieldTitle2": "",
  "UserFieldTitle3": "",
  "UserFieldTitle4": "",
  "UserFieldTitle5": "",
  "CIPCheckConducted": "",
  "GeneratePlastic": 0,
  "IsCardMasked": "",
  "LinkedAccountNumber": "",
  "APIFunction": "",
  "AddAndLoadWalletDetails": [
    {
      "WalletID": 1001,
      "WalletLoadAmount": 20.0
    }
  ],
  "LinkWithExistingCustomer": 1,
  "CustomerID": "1031716"
}
Response Fields Detail
Fields Description

CardHolderName

string

Full Name of Cardholder. Example: Jacob B Jonas

Allowable Values:

40

AccountNumber

string

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

Allowable Values:

19

CardNumber

string

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

Allowable Values:

16

ProxyNumber

string

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

Allowable Values:

19

DDANumber

string

DDA (Direct Deposit Account) which can be used in ACH transactions. Valid values : 0-9 Example:1234567890

Allowable Values:

100

RoutingNumber

string

Bank Routing Number Valid Values:0-9 Example:0110000015

Allowable Values:

10

CustomAccountID

string

Any custom ID which is used to uniquely identify the Account. Valid values: A-Z, a-z, 0-9 Example:123456789 Condition:Mandatory If Custom Account ID on product as Enabled.

Allowable Values:

25

LNResultsGroup

LNResultsGroup

OFACResultsGroup

OFACResultsGroup

LexNexInquiryDate

datetime

Lexis Nexis Inquiry Date Format: yyyy-mm-ddThh:mm:ss Example:2017-09-26T00:00:00

OFACInquiryDate

datetime

OFAC Inquiry Date Format: yyyy-mm-ddThh:mm:ss Example:2017-09-26T00:00:00

OFACScore

string

Score received after OFAC Checks. Example : 2

SDNEntry1

string

Value imposed to an Account after OFAC Check via third party Example:85

SDNEntry2

string

Value imposed to an Account after OFAC Check via third party Example:85

SDNEntry3

string

Value imposed to an Account after OFAC Check via third party Example:85

SDNEntry4

string

Value imposed to an Account after OFAC Check via third party Example:85

SDNEntry5

string

Value imposed to an Account after OFAC Check via third party Example:85

Sample Response Body 

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {
    "CardHolderName": "Mark smith",
    "AccountNumber": "60000000031846",
    "CardNumber": "406683******6077",
    "ProxyNumber": "1316624",
    "DDANumber": "4726120006077",
    "RoutingNumber": "061120084",
    "CustomAccountID": "78545265",
    "LNResultsGroup": {
      "LexNexList": [
        {
          "RiskCodes": "11: The input address may be invalid according to postal specifications"
        }
      ],
      "CVICheckValue": "10",
      "NASCheckValue": "4",
      "LexNexInquiryDate": "2024-08-31T00:00:00"
    },
    "OFACResultsGroup": {
      "OFACInquiryDate": "2024-08-31T00:00:00",
      "OFACScore": "10",
      "SDNEntry1": "83",
      "SDNEntry2": "83",
      "SDNEntry3": "83",
      "SDNEntry4": "83",
      "SDNEntry5": "83"
    }
  }
}