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

OrderID

integer

Conditional

Order ID of the Bulk card order. Valid Values:0-9 Example: 12345 Condition:Either of one identifier is mandatory from:OrderID, BulkCardUUID

BulkCardUUID

string

Conditional

Unique number Bulk card order Valid Values:0-9 Example: 12345 Condition:Either of one identifier is mandatory from:OrderID, BulkCardUUID

Allowable Values:

64

ShippingAddressLine1

string

Optional

Shipping address line 1. Valid Values:A-Z, 0-9 Example:2354 Main road Condition: Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

50

ShippingAddressLine2

string

Optional

Shipping address line 2 Valid Values: A-Z, 0-9 Example:xyz Avenue Condition: Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

50

ShippingCity

string

Optional

Shipping address city name. Example:Los Angeles Condition: Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

25

ShippingPostalCode

string

Optional

Zip code of the shipping address. Valid Values:0-9 Format:XXXXX Example:46206 Condition: Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

9

ShippingCountry

string

Optional

Shipping address Country name. Example:US Condition: Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

5

ShippingState

string

Optional

State of the shipping address. Format:XXXXX Example: AL Condition: Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

30

Title

string

Optional

Title of Person to whom stock is shipped. Example:Mr Condition: Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

5

FirstName

string

Optional

First name of Person to whom stock is shipped. Example:User1 Condition: Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

50

MiddleName

string

Optional

Middle Name of Person to whom stock is shipped. Example: LEE Condition: Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

50

LastName

string

Optional

Last name of Person to whom stock is shipped. Example: Smith Condition: Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

50

NameOnCard

string

Optional

Name to be printed on the card. Valid Values:A-Z, 0-9 Example:John J Condition:If not given then First Name + Last Name will be printed Condition: Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

50

EmbossingLine4

string

Optional

Embossing line4. Condition: Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

20

HoldEmbossing

integer

Optional

Hold Embossing indicator Valid Values:1= YES, 0 = NO Format: X Example: 1

DeliveryMechanism

integer

Optional

Shipment delivery mechanism.By Default Setting must be for standard Delivery Valid Values: Standard = 0, Priority = 1, Overnight = 2 Example:0

NumberOFCard

integer

Optional

Embossing quantity for request made. Valid Values:0-9 Example:10

ResponseID

string

This number indicates that API responded. Response ID is unique.