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

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

CustomerID

string

Conditional

Unique ID associated with Customer. Valid Values:0-9 a-z Format:XXXXX Example:abc2123

NameOnCard

string

Name to be printed on the card. Valid Values:A-Z, 0-9 Format:XXXX Example:John J

Allowable Values:

50

ShippingAddressLine1

string

Shipping address line 1. Example: 2354 Main road

Allowable Values:

50

ShippingAddressLine2

string

Shipping address line 2 Example:xyz Avenue

Allowable Values:

50

ShippingCity

string

Shipping address city name Example: chicago

Allowable Values:

40

ShippingState

string

Sate of the shipping address

Allowable Values:

40

ShippingCountry

string

Shipping address Country name Format: USA

Allowable Values:

40

ShippingPostalCode

string

Zip code of the shipping address.

Allowable Values:

10

ShippingStatus

string

Status of Card Shipping. Valid Values: 0-9, A-Z Format:XXX Example:ABC, AB12

Allowable Values:

10

ShipmentDate

datetime

Shipping Date Valid Values:MM/DD/YYY HH:MM:SS Example:12/24/2019 07:25:12

ShippingMethod

string

Client's shipment menthod. Valid Values: 0-9 a-z

Allowable Values:

20

ShippingMethodID

integer

Unique ID of shipping method Valid Values:0-9 a-z

ShippingMethodDescription

string

Description of Shipment. Valid Values: 0-9 a-z Format: xxxx Example: abcd

Allowable Values:

200

ProgramName

string

Name of Program. Valid Values:0-9 a-z Format:xxxx

Allowable Values:

20

ProgramID

integer

Unique ID of Program. Valid Values: 0-9

DeliveryMechanism

string

Shipment delivery mechanism. Valid Values:a-z Format:xxxx Example:(Overnight, Priority or Standard)

Allowable Values:

40

DeliveryDate

datetime

Date when card is delivered to the card holder. Valid Values: 0-9 Format: MM/DD/YYYY HH:MM:SS Example: 01/01/2020 11:05:05

TrackingNumber

string

Shipment Tracking Number. Valid Values:0-9 a-z Format: xxxx Example:1234ab25

Allowable Values:

20

OrderedOnDate

datetime

Date when shipment is ordered. Valid Values:0-9 Format:mm/dd/yyyy hh:mm:ss Example:02/20/2020 20:20:20

ClientProgramID

string

Client's Program ID Valid Values:0-9 Format:xxxx Example:1234

Allowable Values:

20