Core Card Api Quick Start

UpdateInventoryReceipt

Action: POST

Endpoint: /api/UpdateInventoryReceipt

API Version 1.3

Request fields details

Fields	Description
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 Mandatory	Order number for an inventory. Valid values : 0-9 Example : 3478 Allowable Values: 19
ProxyNumber string Optional	Proxy Number of the cardholder Valid values:0-9 Example:1005 Allowable Values: 19
AccountNumber string Optional	Account Number of the cardholder. Valid values: 0-9 Example: 2000000000000396893 Allowable Values: 19
ReceiptStatus string Mandatory	Status of the inventory Valid values: 1 = Transfer Received 2 = Transfer - Lost in Transit 3 = Transfer - Damaged in Transit 4 = Received 5 = Lost in Transit 6 = Damaged in Transit Example: 1 Allowable Values: 50
ReceiptStatusDate datetime Mandatory	Date on which inventory marked received or lost in transit Format: yyyy-mm-ddThh:mm:ss Example:2017-09-26T00:00:00

Fields

Description

APIVersion

string

Mandatory

Version of the API to be invoked Example: 1.3

Allowable Values:

IPAddress

string

Mandatory

IP Address of sender Example: 10.206.0.204

Allowable Values:

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:

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:

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:

SessionID

string

Optional

Reserved for future use

Allowable Values:

ANI

string

Optional

Reserved for future use

Allowable Values:

DNS

string

Optional

Reserved for future use

Allowable Values:

Language

string

Optional

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

Allowable Values:

RequestDate

string

Optional

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

Allowable Values:

OrderID

string

Mandatory

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

Allowable Values:

ProxyNumber

string

Optional

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

Allowable Values:

AccountNumber

string

Optional

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

Allowable Values:

ReceiptStatus

string

Mandatory

Status of the inventory Valid values: 1 = Transfer Received 2 = Transfer - Lost in Transit 3 = Transfer - Damaged in Transit 4 = Received 5 = Lost in Transit 6 = Damaged in Transit Example: 1

Allowable Values:

ReceiptStatusDate

datetime

Mandatory

Date on which inventory marked received or lost in transit Format: yyyy-mm-ddThh:mm:ss Example:2017-09-26T00:00:00

Sample request body

{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "OrderID": "194468",
  "ProxyNumber": "1316739",
  "AccountNumber": "60000000032489",
  "ReceiptStatus": "1",
  "ReceiptStatusDate": "2020-12-01T00:00:00"
}

Response fields details

Fields	Description
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.

Sample response body

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {}
}