Source

string

Mandatory

Source of API Consumer For external system expected sources will be WEB.

Allowable Values:

50

IPAddress

string

Optional

IP Address of Client / Application Hosting Server Example: 10.206.0.204

Allowable Values:

15

DateFormat

string

Optional

Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS

Allowable Values:

25

CurrencyCode

string

Optional

Currency Code Place Holder for Future Use. Valid Values: Refer Appendix Section - Currency Code Example:840 = US Dollar Condition:If no value is passed, default value = 840

Allowable Values:

10

CurrencySymbolType

string

Optional

Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD

Allowable Values:

10

Language

string

Optional

Place Holder for Future Use. Language: en: means use English Default: en - English

Allowable Values:

10

ExternalIP

string

Mandatory

IP Address of end user of API

Allowable Values:

50

SessionID

string

Optional

Session identifier of the API Example: 000028;026;1349906692

Allowable Values:

100

APIVersion

string

Mandatory

Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0

Allowable Values:

10

CallerID

string

Optional

Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR)

Allowable Values:

20

CalledID

string

Optional

Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR)

Allowable Values:

20

RequestTime

datetime

Optional

Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23

CardNumber

string

Conditional

Card Number of account holder. Valid Values: 0-9 Format:XXXXXXXXXXXXXXXX Example:1236547896325874 Condition:At least one of CardNumber/AdminNumber is required.

Allowable Values:

19

AdminNumber

int64

Conditional

Details can be obtained by admin number (Embossing Acctid). Valid Values:0-9 Example:7485122 Condition:At least one of CardNumber/AdminNumber is required.

CardType

integer

Optional

Type of the card as Visa, Master etc. Valid Values: 0 - MASTER 1 - DISCOVER 2 - STAR 3 - OTHER 4 - VISA 6 - AMEX Example: 4 - VISA

FirstName

string

Conditional

Card Holder's First Name. Valid Values:A-Z Example:John Condition : Required when Card Activation Validation Parameters on Product include First Name.

Allowable Values:

50

MiddleName

string

Conditional

Card Holder's Middle Name. Valid Values: A-Z Example: LEE Condition : Required when Card Activation Validation Parameters on Product include Middle Name.

Allowable Values:

50

LastName

string

Conditional

Card holder's Last Name. Valid Values: A-Z Example: Smith Condition : Required when Card Activation Validation Parameters on Product include Last Name.

Allowable Values:

50

AddressLine1

string

Conditional

Card Holder's Address Line 1. Valid Values:A-Z, 0-9 Example:123 HWY Condition : Required when Card Activation Validation Parameters on Product include AddressLine1.

Allowable Values:

50

AddressLine2

string

Conditional

Card Holder's Address Line 2. Valid Values:A-Z, 0-9 Example:Park Avenue Condition : Required when Card Activation Validation Parameters on Product include AddressLine2.

Allowable Values:

50

EmailID

string

Conditional

Card Holder's Email Address. Valid Values: abc@cc.com Format: xxx@xx.com Example: abc@cc.com Condition : Required when Card Activation Validation Parameters on Product include EmailID.

Allowable Values:

100

HomePhoneNumber

string

Conditional

Card Holder's Home Phone number. Valid Values:0-9 Example:7895463214 Condition : Required when Card Activation Validation Parameters on Product include Home Phone Number.

Allowable Values:

20

WorkPhoneNumber

string

Conditional

Card Holder's Work Phone number. Valid Values:0-9 Example:5678909876 Condition : Required when Card Activation Validation Parameters on Product include Work Phone Number.

Allowable Values:

20

PostalCode

string

Conditional

Postal Code of the Card Holder's Address. Valid Values:0-9 Example:46206 Condition : Required when Card Activation Validation Parameters on Product include Postal Code.

Allowable Values:

10

DateOfBirth

datetime

Conditional

Card Holder's Date of Birth. Valid Values:01/12/1990 Format: MM/dd/yyyy Example:07/25/1991 Condition : Required when Card Activation Validation Parameters on Product include DateOfBirth.

LanguageIndicator

string

Conditional

Language Indicator. Valid Values:en,es Example:es Condition : Required when Card Activation Validation Parameters on Product include LanguageIndicator.

Allowable Values:

5

SocialSecurityNumber

string

Conditional

Social Security Number. Valid Values:0-9 Example: 678051120 Condition : Required when Card Activation Validation Parameters on Product include SocialSecurityNumber.

Allowable Values:

9

CardExpirationDate

string

Conditional

Card Expiration Date of requested card. Valid Values:0-9 Format:MMYYYY Example: 012020 Condition : Required when Card Activation Validation Parameters on Product include CardExpirationDate.

Allowable Values:

8

SSNLast4Digits

string

Conditional

Card Holder's last four digit of SSN. Valid Values:0-9 Example:1120 Condition : Required when Card Activation Validation Parameters on Product include SSNLast4Digits.

Allowable Values:

4

ActivationCode

string

Conditional

Code which is provided at the time of Account Creation/Registration should be pass as a user validation for card. Valid Values:0-9 Example:1120 Condition : Required when Card Activation Validation Parameters include Activation Code.

Allowable Values:

50

IdentifierToken

string

Conditional

A generated token that is not expired can be used as an input field to access API. If we are passing this field in input, user should not pass any other account identifier. Condition:At least one account identifier is required.

Allowable Values:

800

PIN

string

Conditional

Current PIN of the newly embossed card. Example:1234 Condition:Required when Card Activation Validation Parameters on Product include PIN.

CVC2

string

Conditional

CVC2 number of the card generated. Example:123 Condition:Required when Card Activation Validation Parameters on Product include CVC.

EmployeeID

string

Optional

Card Holder's EmployeeID Example:123

Allowable Values:

25