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

AccountNumber

string

Optional

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

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

ProductID

string

Mandatory

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

Allowable Values:

50

BranchCode

string

Mandatory

Branch code from where the card was issued. Valid Values:0-9 Example:1006

Allowable Values:

20

PlasticCode

string

Optional

Plastic Code Valid values:0-9 Example: 32

Allowable Values:

20

FromCardNumber

string

Optional

Beginning range of card number. Valid values: 0-9 Example: 4066846120023634

Allowable Values:

16

ToCardNumber

string

Optional

End range of card number. Valid values: 0-9 Example: 4066846120023634

Allowable Values:

16

ProxyNumberFrom

string

Optional

Beginning range of Proxy Number. Valid values: 0-9 Example: 1001741741741

Allowable Values:

19

ProxyNumberTo

string

Optional

End range of Proxy Number. Valid values: 0-9 Example: 1001741741741

Allowable Values:

19

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.

InventoryTransferRecord

array

OrderID

Int32

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

ProductID

Int32

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

ApprovedBy

string

UserID of the person who approved the inventory order. Example:abcd.admin

RequestedBy

string

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

CardInInventory

string

Number of cards in inventory for particular order id. Valid Values - 0-9 Example : 2500