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

MerchantID

integer

Conditional

Unique number of merchant account. Valid Values: 0-9 Format: XXXXX Example: 12345 Condition: Either of one identifier is mandatory from: MerchantID, OrderID, BulkCardUUID, ProductID, StoreID

OrderID

integer

Conditional

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

BulkCardUUID

string

Conditional

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

Allowable Values:

64

ProductID

integer

Conditional

ID assigned to a Program Valid Values: 0-9 Format: XXXX Example: Fixed value provided by CoreCard. Condition: Either of one identifier is mandatory from: MerchantID, OrderID, BulkCardUUID, ProductID, StoreID

StoreID

integer

Conditional

Store ID Valid Values: XXX Format: 0-9 Example: 1234 Condition: Either of one identifier is mandatory from: MerchantID, OrderID, BulkCardUUID, ProductID, StoreID

CardNumber

string

Optional

Card Number of account holder Valid Values: 0-9 Format: XXXXXXXXXXXXXXXX Example: 1236547896541236

Allowable Values:

19

AccountNumber

string

Optional

Debtor File # or Client Account # Valid Values: 0-9 Format: XXXXXXXXXX Example: 7314145404 Condition: At least one account identifier is required.

Allowable Values:

19

DeliveryMechanism

string

Optional

Shipment delivery mechanism. By Default Setting must be for standard Delivery Valid Values: a-z Format: xxxx Example: (Overnight, Priority or Standard)

Allowable Values:

50

OderStatus

string

Optional

It has values as Approval pending, Approved, Cards Created, Rejected. Valid Values: A-Z Format: XXXXXXXXX Example: Approval pending

Allowable Values:

50

BulkRequestDetails

array

List of the following Bulk card tags

ResponseID

int64

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

CurrencySymbol

string

This tag reflects the currency symbol

BulkRequestDetails

array

List of the following Bulk card tags

ResponseID

int64

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

CurrencySymbol

string

This tag reflects the currency symbol