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

BatchSize

integer

Optional

Number of search record which can be view in one Batch. 50 is default value Valid Values:0-9 Example:20

PageIndex

integer

Optional

Number of page. 0 is default value. Valid Values:0-9 Example:12

ClientID

integer

Optional

Client ID of the client. Valid Values:0-9 Example:485214

ProductID

integer

Optional

Product ID Valid Values:0-9 Example:1234

StoreID

integer

Optional

Specific code assigned to a Store. Valid Values:0-9 Example:1234

CustomerType

string

Optional

Type of Customer. Valid Values: 01 = Individual 02 = Organization 03 = Anonymous 04 = Funder 06 = Recipient 07 = Owning Partner 08 = Partner Store 09 = Purged 10 = Register Example: Individual / Organization etc.

Allowable Values:

2

AccountNumber

string

Optional

Account number of cardholder. Valid Values: 0-9 Format:XXXXXXXXXXXX Example:123654789632

Allowable Values:

19

AdminNumber

int64

Optional

Details can be obtained by admin number (Embossing Acctid) Valid Values:0-9 Example:4851455

CardType

string

Optional

Specifies the type of Card. Valid Values: 0 = Primary Card 1 = Secondary Card 2 = Virtual Secondary Card Example:0 = Primary Card

Allowable Values:

5

CustomerID

string

Optional

Unique ID associated with Customer Valid Values: 0-9 a-z Example: 12345

Allowable Values:

25

ApplicationID

int64

Optional

This tag reflects the ApplicationID Valid Values:0-9 Example:12345

TransactionID

int64

Optional

Transaction Number for the transaction being posted. Valid Values:0-9 a-z Example:23654789

DateOfBirth

datetime

Optional

Card Holder's Date of Birth Valid Values: 0-9 Format: MM/dd/yyyy Example:02/01/2020

FirstName

string

Optional

Card holder's First name. Valid Values:A-Z Example : John Condition: Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

50

LastName

string

Optional

Card holder's last name. Valid Values:A-Z Example : Smith Condition: Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

50

CardNumberLast4Digit

string

Optional

Last 4 digits of card number Valid Values:0-9 Example:1234

Allowable Values:

4

SearchCardResult

array

SearchCardResult