APIVersion

string

Mandatory

Version of the API to be invoked Example: 1.3

Allowable Values:

10

IPAddress

string

Mandatory

IP Address of sender Example: 10.206.0.204

Allowable Values:

15

Source

string

Mandatory

Source from where API Call is initiated. CoreCard have multiple value of source for internal system (CoreMoney, SelfService, IVR, MobileSelfService) For external system expected source will be WEB.

Allowable Values:

50

CallerID

string

Optional

Caller Id of source from where API is initiated. It is End User phone number. Example: 7204454214 Condition - applicable in Case of IVR

Allowable Values:

20

CalledID

string

Optional

Called Id of destination for which API is initiated. It is Corecard IVR number. Example: 7314145404 Condition - applicable in Case of IVR

Allowable Values:

20

SessionID

string

Optional

Reserved for future use

Allowable Values:

50

ANI

string

Optional

Reserved for future use

Allowable Values:

0

DNS

string

Optional

Reserved for future use

Allowable Values:

0

Language

string

Optional

Flag to retrieve error message in specific language Example: 'en' for English

Allowable Values:

2

RequestDate

string

Optional

Request Date Time of API Format: MM-DD-YYYYTHH:MM:SS Example:- 11-12-2021T13:05:10

Allowable Values:

19

OrderID

string

Optional

Order number for an inventory. Valid values : 0-9 Example : 3478

Allowable Values:

19

ClientID

string

Optional

Client Id Valid Values: 1422245 Format:XXXXX

Allowable Values:

50

InventoryStatus

string

Optional

Status of the inventory Valid values : 1= Approval Pending 2 = Approved 3 = Cards Created 4 = Inventory Dispatch 5 = Received 6 = Inventory Received with return 7 = Lost in Transit 8 = Damaged in Transit 9 = Transfer Received 10 = Transfer Received with return 11 = Transfer - In Transit 12 = Transfer - Lost in Transit 13 = Transfer - Damaged in Transit 14 = Error 15 = Rejected

Allowable Values:

50

ProductID

string

Optional

ID of the Account's Product Valid Values:0-9 Example: 1739,1758

Allowable Values:

10

PlasticCode

string

Optional

Plastic Code Valid values:0-9 Example: 32

Allowable Values:

100

BranchCode

string

Optional

Code assigned to branch from where the card was issued. Valid Values:0-9, A-Z Example:C1006

Allowable Values:

20

AccountNumber

string

Optional

Account Number of the cardholder. Valid values: 0-9 Example: 2000000000000396893

Allowable Values:

19

ProxyNumber

string

Optional

Proxy Number of the cardholder Valid values:0-9 Example:1005

Allowable Values:

19

OrderRequestDate

string

Optional

Date of requesting order Format:mm/dd/yyyy Example:09/26/2020

Allowable Values:

10

CreateDate

string

Optional

Date of order creation Format:mm/dd/yyyy Example:09/26/2020

Allowable Values:

10

NumberOfCard

string

Optional

Total number of cards. Valid values: 0-9 Example: 17

Allowable Values:

10

CardNumber

string

Optional

Clear Card Number of the cardholder Valid values: 0-9 Example: 123456******0001

Allowable Values:

16

Message

string

Returns Error Message in case of Error.

Status

boolean

Returns result of API processing. If any error is found then value will be 'false' else 'true'.

ErrorCode

string

Returns Error Code in case of Error.

ResponseData

This is group of below data elements.

SearchInventoryList

array

OrderId

Int32

Order number for an inventory. Valid values : 0-9 Example : 3478

RequestedOn

string

Request date time of activity Format: MM/DD/YYYY HH:mm:ss:msi Example: 09/12/2016 15:51:19:000

NumberOfCard

Int32

Total number of cards. Valid values: 0-9 Example: 17

InventoryStatus

string

Status of the inventory Valid values : 1= Approval Pending 2 = Approved 3 = Cards Created 4 = Inventory Dispatch 5 = Received 6 = Inventory Received with return 7 = Lost in Transit 8 = Damaged in Transit 9 = Transfer Received 10 = Transfer Received with return 11 = Transfer - In Transit 12 = Transfer - Lost in Transit 13 = Transfer - Damaged in Transit 14 = Error 15 = Rejected

RequestedBy

string

User id of the user who requested the inventory. Example : abc.cc.admin

ProductName

string

Name of the Account's Product Valid Values:0-9, A-Z Example: Cash card

MultiplePlastic

string

multiple plastics for the same card or not. Valid Values: Yes,No

BranchStoreName

string

Store Name of the branch Valid values : A-Z Example - head office