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

Allowable Values:

19

NewSSUserID

string

Mandatory

Self Service New User ID to be provided for the Account Holder Valid Values: 0-9 Format: XXXXXX Example: Dani123

Allowable Values:

20

AddressLine1

string

Conditional

Card holder's Address Line 1 Valid Values:A-Z, 0-9 Example:123 HWY Condition:Address Line 1 of the Account Holder, Mandatoy if Set as one of the Self Service Registration Parameter in System and is Set as 'Mandatory' in System

Allowable Values:

50

AddressLine2

string

Conditional

Card holder's Address Line 2 Valid Values:A-Z, 0-9 Example:123 HWY Condition:Address Line 2 of the Account Holder, Mandatoy if Set as one of the Self Service Registration Parameter in System and is Set as 'Mandatory' in System

Allowable Values:

50

Country

string

Conditional

Country name of the Card holder's address For Input Values Refer Appendix Section 5.1 for Country Name Codes Valid Values: a-z Format:XXX Example:US Condition:Country Name of the Account Holder, Mandatoy if Set as one of the Self Service Registration Parameter in System and is Set as 'Mandatory' in System

Allowable Values:

3

City

string

Conditional

Primary Applicant's City Example: Los Angeles Condition:City Name of the Account Holder, Mandatoy if Set as one of the Self Service Registration Parameter in System and is Set as 'Mandatory' in System

Allowable Values:

40

PostalCode

string

Conditional

Postal code of the card holder's address. Valid Values:0-9 Format:XXXXX Example:46206 Condition:Address Postal Code of the Account Holder, Mandatoy if Set as one of the Self Service Registration Parameter in System and is Set as 'Mandatory' in System

Allowable Values:

9

State

string

Conditional

State of the card holder address. For Input Values Refer Appendix Section 5.6 for State Name Codes. Valid Values: a-z Format:XXX Example:MO Condition:State Name of the Account Holder, Mandatoy if Set as one of the Self Service Registration Parameter in System and is Set as 'Mandatory' in System

Allowable Values:

3

EmailID

string

Conditional

Card holder's Email ID Valid Values: 0-9, A-Z Format:XX@XX.Com Example:ABC@gmail.com Condition:the Email Address of the Account Holder, Mandatoy if Set as one of the Self Service Registration Parameter in System and is Set as 'Mandatory' in System

Allowable Values:

100

NewPassword

string

Mandatory

Password to be Provided for the Account Holder for SelfService Login As per Password Policy Set in System

Allowable Values:

32

ConfirmPassword

string

Mandatory

Verification of the new requested password by the user, Must be exactly same as the New Password

Allowable Values:

32

SSNLast4Digits

string

Conditional

Card holder's last four digit of SSN Valid Values:1120 Format:XXXX Example:1120 Condition:Last 4 digits of the SSN of the Account Holder, Mandatoy if Set as one of the Self Service Registration Parameter in System and is Set as 'Mandatory' in System

Allowable Values:

4

DateOfBirth

datetime

Conditional

Card Holder's Date of Birth Valid Values: 0-9 Format: MM/dd/yyyy Example: 02/01/2020 Condition:Date of Birth of the Account Holder, Mandatoy if Set as one of the Self Service Registration Parameter in System and is Set as 'Mandatory' in System

CardVerificationValue

string

Conditional

CardVerificationValue number mentioned on the Card of the Account Holder Valid Values:0-9 Format: XXX Example: 123 Condition:CardVerificationValue number mentioned on the Card of the Account Holder, Mandatoy if Set as one of the Self Service Registration Parameter in System and is Set as 'Mandatory' in System

Allowable Values:

3

ListSecurityQuestionsAnswers

array

Mandatory

List of Security Questions IDs and Descriptions as set in the System on the Product

AccountNumber

string

Conditional

Account number of cardholder. Valid Values: 0-9 Format: XXXXXXXXXXXXXXXX Example: 1236547896325874 Condition: At least one of AdminNumber/AccountNumber is required.

Allowable Values:

19

AdminNumber

int64

Conditional

Details can be obtained by admin number (Embossing Acctid) Valid Values: 0-9 Format: XXXXX Example: 12345 Condition: At least one of AdminNumber/AccountNumber is required when Decision Flag tag would be 1 -Account level Memo.