GetInventoryTransferReceipt
Action: POST
Endpoint: /api/GetInventoryTransferReceipt
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 |
Sample request body
{ "APIVersion": "1.3", "IPAddress": "10.206.2.197", "Source": "WEB", "CallerID": "", "CalledID": "", "SessionID": "", "ANI": "", "DNS": "", "Language": "en", "RequestDate": "" }
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. |
InventoryTransferReceiptDetailsModelList array |
|
OrderID string |
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 |
ProductName string |
Name of the Account's Product Valid Values:0-9, A-Z Example: Cash card |
Quantity Int32 |
Number of cards ordered in inventory Valid values - 0-9 Example : 850 |
TransferredBy string |
Userid of the user who transferred inventory Valid values - 0-9, a-z Example - Admin |
TransferredOn datetime |
Date of Transfer for inventory cards Format: yyyy-mm-ddThh:mm:ss Example: 2017-09-26T00:00:00 |
SourceBranchName string |
Source Branch Name Valid values - a-z, 0-9 Example: meca way Branch |
SourceBranchNameCode string |
Source Branch Code Valid values - 0-9, a-z Example - C8745 |
DestinationBranchName string |
Destination Branch Name Valid values - a-z, 0-9 Example: meca way Branch |
DestinationBranchNameCode string |
Destination Branch Code Valid values - 0-9, a-z Example - C8745 |
CardNumberFrom string |
Beginning Range of Card number Valid values: 0-9 Example: 4601001741741741 |
CardNumberTo string |
Ending range of card number Valid values: 0-9 Example: 4610017417417416 |
ProxyNumberFrom string |
Beginning range of Proxy Number. Valid values: 0-9 Example: 1001741741741 |
ProxyNumberTo string |
The Proxy number till where a transaction shall be initiated Valid values: 0-9 Example: 1001741741741 |
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 |
ReceiptStatus string |
Status of the inventory Valid values: Transfer Received Transfer - Lost in Transit Transfer - Damaged in Transit Transfer Received with Return Example: Transfer Received |
ReceiptStatusDate datetime |
Date on which inventory marked received or lost in transit Format: yyyy-mm-ddThh:mm:ss Example:2017-09-26T00:00:00 |
Sample response body
{ "Message": "Successful.", "Status": true, "ErrorCode": "00000", "ResponseData": { "InventoryTransferReceiptDetailsModelList": [ { "OrderID": "194467", "ProductID": 1739, "ProductName": "Convenient Access Visa Prepaid Card - AC155", "Quantity": 2, "TransferredBy": "demo", "TransferredOn": "2020-02-10T00:00:00", "SourceBranchName": "Convenient Card Top branch", "SourceBranchNameCode": "CC10000", "DestinationBranchName": "Bank A", "DestinationBranchNameCode": "BankA2000", "CardNumberFrom": "406684******2702", "CardNumberTo": "406684******2710", "ProxyNumberFrom": "1316570", "ProxyNumberTo": "1316571", "ShippingMode": "Standard", "AWBNumber": "", "ReceiptStatus": "Transfer Received", "ReceiptStatusDate": "2020-02-10T00:00:00" } ] } }