Category links

API Links

GetInventoryCardDetails

Action: POST

Endpoint: /api/GetInventoryCardDetails

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

FetchDetail

string

Mandatory

Cards to be fetched. Value : 1 = To fetch all type of cards. 2 = To fetch only those cards which are transferrable from one branch to another branch.

ProxyNumberFrom

string

Optional

From range to search accounts Note : Applicable when FetchDetail value is 2

Allowable Values:

19

ProxyNumberTo

string

Optional

To range to search accounts Note : Applicable when FetchDetail value is 2

Allowable Values:

19

PlasticCode

string

Optional

Plastic Code Valid values:0-9 Example: 32 Note : Applicable when FetchDetail value is 2

Allowable Values:

100

Sample request body
{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "OrderID": "194480",
  "FetchDetail": "1",
  "ProxyNumberFrom": "194480",
  "ProxyNumberTo": "194485",
  "PlasticCode": "49"
}
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.

InventoryCardDetailsRecordList

array

AccountNumber

string

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

FirstName

string

Cardholder First Name Valid Values: A-Z, a-z Example: Andrew

LastName

string

Cardholder Last Name Valid values: A-Z, a-z Example: Hudson

MiddleName

string

Cardholder Middle Name Valid values are A-Z, a-z, 0-9 Example: Charles

NameOnCard

string

Name to be Embossed on Card Valid values are A-Z, a-z, 0-9. Example: Hudson M Charles

MaskedCardNumber

string

Card number in masked form Valid values: 0-9 Example: 123456******0001

PlasticCode

string

Plastic Code Valid values:0-9 Example: 32

ProxyNumber

string

Proxy Number. Example:1050

Sample response body

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {
    "InventoryCardDetailsRecordList": [
      {
        "AccountNumber": "60000000025236",
        "FirstName": "interface",
        "LastName": "gift",
        "MiddleName": "",
        "NameOnCard": "interface gift",
        "MaskedCardNumber": "406683******4296",
        "PlasticCode": "Clasic Gift cardValid (30)",
        "ProxyNumber": "1314898"
      },
      {
        "AccountNumber": "60000000025228",
        "FirstName": "interface",
        "LastName": "gift",
        "MiddleName": "",
        "NameOnCard": "interface gift",
        "MaskedCardNumber": "406683******4288",
        "PlasticCode": "Clasic Gift cardValid (30)",
        "ProxyNumber": "1314897"
      }
    ]
  }
}