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

CardNumber

string

Conditional

Clear Card Number of the cardholder Valid values: 0-9 Example: 123456******0001 Condition :At least one of Card Number/Proxy Number/Account Number is required.

Allowable Values:

16

AccountNumber

string

Conditional

Account Number of the cardholder. Valid values: 0-9 Example: 2000000000000396893 Condition :At least one of Card Number/Proxy Number/Account Number is required.

Allowable Values:

19

ProxyNumber

string

Conditional

Proxy Number of the cardholder Valid values:0-9 Example:1005 Condition :At least one of Card Number/Proxy Number/Account Number is required.

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.

InventoryCardTransferHistoryItems

array

OrderID

string

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

FromBranchCode

string

Branch code of the branch from where the card will be sent to another branch Valid Values: A-Z, a-z, 0-9 , Example:AC1006

ToBranchCode

string

Branch code of the branch where the card will be received. Valid Values: A-Z, a-z, 0-9 , Example:DC1006

UserID

string

UserId of the cardholder Valid Values: A-Z,a-z,0-9. Example : Sam

UserName

string

User name of the cardholder. Valid values : A-Z, a-z, 0-9 Example:John

InventoryStatus

string

Status of the inventory Valid values : Approval Pending Approved Cards Created Inventory Dispatch Received Inventory Received with return Lost in Transit Damaged in Transit Transfer Received Transfer Received with return Transfer - In Transit Transfer - Lost in Transit Transfer - Damaged in Transit Error Rejected

ShippingMode

string

Shipping Method to send cards valid values 0=Standard 1=Priority 2=Overnight Example : 0

AWBNumber

string

Air Way Bill Number of an inventory transfer Valid values: 0-9 Example:156463

ActivityDateTime

datetime

Date and time of activity. Format: yyyy-mm-ddThh:mm:ss Example:2017-09-26T00:00:00