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:1236547896541236 Condition: At least one of Card Number\Admin Number 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 Card Number\Admin Number is required

NewPIN

string

Optional

New pin for the card.

Allowable Values:

4

ConfirmPIN

string

Optional

Confirmation of new pin.

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: Required if it is set in the “Authentication For PIN Change” at Program Parameters.

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

EmployeeID

string

Conditional

Employee ID mapped on the Card. Valid Values: 0-9, A-Z Format:XXXXX Example:A1234 Condition: Required if it is set in the “Authentication For PIN Change” at Program Parameters.

Allowable Values:

20

ZipCode

string

Conditional

Zip/Postal code mapped on the card. Valid Values: 0-9, A-Z Format:XXXXX Example:46206 Condition: Required if it is set in the “Authentication For PIN Change” at Program Parameters.

Allowable Values:

9

CardExpirationDate

string

Conditional

Card Expiration Date of the card. Valid Values: 0-9 Format: MMYYYY Condition: Condition: Required if it is set in the “Authentication For PIN Change” at Program Parameters.

Allowable Values:

6

ResponseID

string

This number indicates that API responded.Response ID is unique.This value will be null if no authentication information was passed. Response ID can be used for tracking Valid Values:0-9,a-z Format:xxx Example:200

Allowable Values:

15