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

CustomerID

string

Conditional

Unique ID associated with Customer. Valid Values: 0-9 Example: 121730 Condition:At least one of CustomerID/AdminNumber is required.

Allowable Values:

10

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 CustomerID/AdminNumber is required.

AccountNumber

string

Conditional

Account number of cardholder/AccountHolder. *if a Specific Account Number is Inputted, then the Account Number specifc Application Details will be fetched Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404121234569 Condition:At least one of AccountNumber/CustomerID/AdminNumber is required.

Allowable Values:

19

AdditionalAddressFirstName

string

First Name provided in additional address section

Allowable Values:

50

AdditionalAddressMiddleName

string

Middle Name provided in additional address section

Allowable Values:

50

AdditionalAddressLastName

string

Last Name provided in additional address section

Allowable Values:

50

AdditionalAddressEmail

string

Cardholder's email ID associated with additional address details Valid Values: 0-9 a-z Format:xxx @xxx.xxx Example:abc @xyz.com

Allowable Values:

300

AdditionalAddressPhoneNumber

string

Cardholder's Phone Number associated with additional address details Valid Values:0-9 Example:12346678912

Allowable Values:

11

AdditionalAddressLine1

string

Cardholder's Address Line 1 associated with additional address details Valid Values: 0-9 a-z Example: add line 1

Allowable Values:

50

AdditionalAddressLine2

string

Cardholder's Address Line 2 associated with additional address details Valid Values: 0-9 a-z Example: add line 2

Allowable Values:

50

AdditionalAddressCity

string

Cardholder's City associated with additional address details Valid Values: a-z Format:xxxx Example:Kansas

Allowable Values:

25

AdditionalAddressState

string

Cardholder's State/Province associated with additional address details Valid Values: a-z Format: xxxx Example: CA

Allowable Values:

25

AdditionalAddressCountry

string

Cardholder's Country associated with additional address details Valid Values: a-z Format:xxxx Example:US

Allowable Values:

25

AdditionalAddressPostalCode

string

Cardholder's PostalCode associated with additional address details Valid Values:0-9 Format:xxxx Example:123456

Allowable Values:

9

AdditionalAddressBadAddress

boolean

Flag to mark cardholder's additional detail as bad address Valid Values: true/false Example: true