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

AdminNumber

int64

Conditional

Admin Number of Primary Account Number Valid Values: 0-9 Format:XXXXX Example:12345 Condition:At least one account identifier is required.

CardExpirationDate

string

Optional

Expiration date and month of PAN Valid Values: 0-9 Format:MMYY Example:0121

Allowable Values:

4

TavVersionNumber

string

Mandatory

TAV Format Valid Values:3 Format:X Example:3

Allowable Values:

1

DataValidUntilTimestamp

string

Mandatory

ISO 8601 format of the date and time(with Time Zone) the TAV expires and will no longer be honored Valid Values:0-9 Example:2019-12-27T10:05:45-05:00

Allowable Values:

29

FinancialAccountInformation

string

Optional

Identifier of the financial account being tokenized Valid Values:0-9,a-z Example:1235abcd

Allowable Values:

78

TokenUniqueReference

string

Optional

Token Unique Reference associated with the token. Valid Values:0-9,a-z Example: D313958EB444F9A887E96F98483D6FF4E198815DC7BF4C72322E473E9CEF83E27E2F9BCA8762E3121D4FD1FD32B,

Allowable Values:

64

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

AdminNumber

integer

Admin Number of Primary Account Number Valid Values: 0-9 Format:XXXX Example:200

IncludedFieldsInOrder

string

Concatenated string of fields in TAV signature, separated by “|”,in their order in signature. Example:dataValidUntilTimestamp|accountNumber|accountExpiry|financialAccountInformation|tokenUniqueReference

DigitalSignature

string

Digital signature calculated over a concatenated string of the included field values separated by a | delimiter, in the same order as specified in the IncludedFieldsInOrder field. Example:6523026E6214927059B98F8DC859EF5B2B6F7F6D9E7DAC13B38DCE6F0991F5F37DB7F9B95BD4BA8F9E6157CA1A5C8B5F880E044DD1A0D0F667F0D80619AE2637EF04BE80C4A05A8C98AA090A15EA29A43BC0846D6074724105839E8D7FC582F607C0CC40C29BF2586AE4CBE29E43E32665923838ED331CD56A557322B