Inventory Management

The CoreCard system provides a facility to order non personalized cards in bulk. Both, Gifts cards and individual cards can be created in bulk.These cards are sold from the branch afterward. purchaser information is entered while selling gift cards and cardholder information is entered while selling individual cards. The facility of transferring these cards to other branches is also provided by Corecard until cards are not sold. These cards can also be used when the customer wants to replace a card and wants the card at the branch only.

AddInventory

Action: POST

Endpoint: /api/AddInventory

POST /api/AddInventory

Use this API to Create/Update/Approve/Reject Inventory based on decision flag.

Request Fields Detail

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
BranchCode string Mandatory	Code assigned to branch from where the card was issued. Valid Values:0-9, A-Z Example:1006 Condition : Mandatory when decision flag is 1 Allowable Values: 20
ProductID Int32 Conditional	ID of the Account's Product Valid Values:0-9 Example: 1739,1758 Condition : Mandatory when decision flag is 1 Allowable Values: 10
ClientID string Optional	Client Id Valid Values: 1422245 Format:XXXXX Allowable Values: 50
ShippingMode string Optional	Shipping Method to send cards valid values 0=Standard 1=Priority 2=Overnight Example : 0 Allowable Values: 50
AcctYesNo string Mandatory	whether Account number should be printed in embossing file or not. Valid Values : 1 ,2 1= YES 2= NO Condition : Mandatory when decision flag is 1 Allowable Values: 1
Title string Optional	Title for the customer Valid Values: Refer Appendix Section : Title Values Example: Mr. Allowable Values: 9
FirstName string Optional	Cardholder First Name Valid Values: A-Z, a-z Example: Andrew Allowable Values: 50
MiddleName string Optional	Cardholder Middle Name Valid values are A-Z, a-z, 0-9 Example: Charles Allowable Values: 50
LastName string Optional	Cardholder Last Name Valid values:A-Z, a-z Example: Hudson Allowable Values: 50
NameOnCard string Optional	Name to be Embossed on Card Valid values are A-Z, a-z, 0-9. Example: Hudson M Charles Allowable Values: 28
EmbossingLine4 string Optional	Text to be print on Line 4 of a plastic. Valid Values:a-z, A-Z Allowable Values: 26
Addressline1 string Conditional	Address Line 1 of the Cardholder Valid values : A-Z, a-z, 0-9 Example: 15 Penang Street Point Condition : Mandatory when decision flag is 1 Allowable Values: 50
Addressline2 string Optional	Address Line 2 of the Cardholder Valid values: A-Z, a-z, 0-9 Example: 1 mecca way Allowable Values: 50
City string Conditional	Cardholder's City of residence Valid values: A-Z, a-z, 0-9 Example: Norcross Condition : Mandatory when decision flag is 1 Allowable Values: 25
ZIPCode string Conditional	Cardholder Postal Code of Residence Valid Values:A-Z,a-z,0-9 Example: 30093 Condition : Mandatory when decision flag is 1 Allowable Values: 10
Country string Conditional	Two Character Country Code Valid values :A-Z, a-z Example: US Refer Appendix section : Country Code Value Condition : Mandatory when decision flag is 1 Allowable Values: 2
State string Conditional	Cardholder State of residence Valid values are A-Z, a-z Example: GA Please refer Appendix Section : State Codes(US) Condition : Mandatory when decision flag is 1 Allowable Values: 3
UserID string Mandatory	User id of the user performing the activity. Valid Values: A-Z,a-z,0-9. Example : Sam Allowable Values: 128
FICompanyName string Conditional	Company name Condition : Mandatory when decision flag is 1 Allowable Values: 26
OrderId decimal Conditional	Order number for an inventory. Valid values : 0-9 Example : 3478 Condition: Mandatory When decision flag = 2,3, 4
DecisionFlag string Mandatory	Flag to decides which operation needs to be performed. Valid Values: 1 = creating an inventory 2 = updating an inventory 3 = Approving an inventory 4 = Rejecting an inventory Allowable Values: 2
PlasticDetailsType array Optional

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:

BranchCode

string

Mandatory

Code assigned to branch from where the card was issued. Valid Values:0-9, A-Z Example:1006 Condition : Mandatory when decision flag is 1

Allowable Values:

ProductID

Int32

Conditional

ID of the Account's Product Valid Values:0-9 Example: 1739,1758 Condition : Mandatory when decision flag is 1

Allowable Values:

ClientID

string

Optional

Client Id Valid Values: 1422245 Format:XXXXX

Allowable Values:

ShippingMode

string

Optional

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

Allowable Values:

AcctYesNo

string

Mandatory

whether Account number should be printed in embossing file or not. Valid Values : 1 ,2 1= YES 2= NO Condition : Mandatory when decision flag is 1

Allowable Values:

Title

string

Optional

Title for the customer Valid Values: Refer Appendix Section : Title Values Example: Mr.

Allowable Values:

FirstName

string

Optional

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

Allowable Values:

MiddleName

string

Optional

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

Allowable Values:

LastName

string

Optional

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

Allowable Values:

NameOnCard

string

Optional

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

Allowable Values:

EmbossingLine4

string

Optional

Text to be print on Line 4 of a plastic. Valid Values:a-z, A-Z

Allowable Values:

Addressline1

string

Conditional

Address Line 1 of the Cardholder Valid values : A-Z, a-z, 0-9 Example: 15 Penang Street Point Condition : Mandatory when decision flag is 1

Allowable Values:

Addressline2

string

Optional

Address Line 2 of the Cardholder Valid values: A-Z, a-z, 0-9 Example: 1 mecca way

Allowable Values:

City

string

Conditional

Cardholder's City of residence Valid values: A-Z, a-z, 0-9 Example: Norcross Condition : Mandatory when decision flag is 1

Allowable Values:

ZIPCode

string

Conditional

Cardholder Postal Code of Residence Valid Values:A-Z,a-z,0-9 Example: 30093 Condition : Mandatory when decision flag is 1

Allowable Values:

Country

string

Conditional

Two Character Country Code Valid values :A-Z, a-z Example: US Refer Appendix section : Country Code Value Condition : Mandatory when decision flag is 1

Allowable Values:

State

string

Conditional

Cardholder State of residence Valid values are A-Z, a-z Example: GA Please refer Appendix Section : State Codes(US) Condition : Mandatory when decision flag is 1

Allowable Values:

UserID

string

Mandatory

User id of the user performing the activity. Valid Values: A-Z,a-z,0-9. Example : Sam

Allowable Values:

128

FICompanyName

string

Conditional

Company name Condition : Mandatory when decision flag is 1

Allowable Values:

OrderId

decimal

Conditional

Order number for an inventory. Valid values : 0-9 Example : 3478 Condition: Mandatory When decision flag = 2,3, 4

DecisionFlag

string

Mandatory

Flag to decides which operation needs to be performed. Valid Values: 1 = creating an inventory 2 = updating an inventory 3 = Approving an inventory 4 = Rejecting an inventory

Allowable Values:

PlasticDetailsType

array

Optional

Sample Request Body

{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "BranchCode": "CC10000",
  "ProductID": 1754,
  "ClientID": "5617",
  "ShippingMode": "0",
  "AcctYesNo": "1",
  "Title": "",
  "FirstName": "",
  "MiddleName": "",
  "LastName": "",
  "NameOnCard": "",
  "EmbossingLine4": "The Perfect Gift",
  "Addressline1": "Addrress1",
  "Addressline2": "Addresss2",
  "City": "New York City",
  "ZIPCode": "12345",
  "Country": "US",
  "State": "NY",
  "UserID": "ccadmin",
  "FICompanyName": "isc",
  "OrderId": 194480.0,
  "DecisionFlag": "1",
  "PlasticDetailsType": [
    {
      "PlasticCode": "44",
      "LogoID": "15",
      "NumberOfCards": 15
    }
  ]
}

Response Fields Detail

Fields	Description

Sample Response Body

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {
    "OrderID": 194480.0,
    "RequestIDList": [
      {
        "RequestID": 3264.0
      },
      {
        "RequestID": 3265.0
      }
    ]
  }
}

GetCardTransferHistory

Action: POST

Endpoint: /api/GetCardTransferHistory

POST /api/GetCardTransferHistory

Use this API to get details of the card Transfer.

Request Fields Detail

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
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

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:

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:

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:

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:

Sample Request Body

{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "CardNumber": "406684******7289",
  "AccountNumber": "60000000032489",
  "ProxyNumber": "1316739"
}

Response Fields Detail

Fields	Description
InventoryCardTransferHistoryItems array

Fields

Description

InventoryCardTransferHistoryItems

array

Sample Response Body

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {
    "InventoryCardTransferHistoryItems": [
      {
        "OrderID": "194467",
        "FromBranchCode": "Advantage Community Bank",
        "ToBranchCode": "Convenient Card Top branch (CC10000)",
        "UserID": "ccadmin",
        "UserName": "CC Admin",
        "InventoryStatus": "Cards Created",
        "ShippingMode": "Standard",
        "AWBNumber": "156463",
        "ActivityDateTime": "2020-02-10T00:00:00"
      }
    ]
  }
}

GetInventoryCardDetails

Action: POST

Endpoint: /api/GetInventoryCardDetails

POST /api/GetInventoryCardDetails

Use this API to fetch details of inventory cards like Account number , proxy number and name.

Request Fields Detail

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

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:

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:

ProxyNumberTo

string

Optional

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

Allowable Values:

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 Detail

Fields	Description

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"
      }
    ]
  }
}

GetInventoryTransferDetails

Action: POST

Endpoint: /api/GetInventoryTransferDetails

POST /api/GetInventoryTransferDetails

Use this API to fetch the transferred Inventory details.

Request Fields Detail

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
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

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:

AccountNumber

string

Optional

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

Allowable Values:

OrderID

string

Optional

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

Allowable Values:

ClientID

string

Optional

Client Id Valid Values: 1422245 Format:XXXXX

Allowable Values:

ProductID

string

Mandatory

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

Allowable Values:

BranchCode

string

Mandatory

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

Allowable Values:

PlasticCode

string

Optional

Plastic Code Valid values:0-9 Example: 32

Allowable Values:

FromCardNumber

string

Optional

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

Allowable Values:

ToCardNumber

string

Optional

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

Allowable Values:

ProxyNumberFrom

string

Optional

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

Allowable Values:

ProxyNumberTo

string

Optional

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

Allowable Values:

Sample Request Body

{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "AccountNumber": "60000000032489",
  "OrderID": "194496",
  "ClientID": "5617",
  "ProductID": "1739",
  "BranchCode": "CC10000",
  "PlasticCode": "002",
  "FromCardNumber": "4066846120012017",
  "ToCardNumber": "4066846120012020",
  "ProxyNumberFrom": "1316180",
  "ProxyNumberTo": "1316183"
}

Response Fields Detail

Fields	Description
InventoryTransferRecord array

Fields

Description

InventoryTransferRecord

array

Sample Response Body

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {
    "InventoryTransferRecord": [
      {
        "OrderID": 194467,
        "ProductID": 1739,
        "ApprovedBy": "ccadmin",
        "RequestedBy": "ccadmin",
        "CardInInventory": "2"
      }
    ]
  }
}

GetInventoryTransferReceipt

Action: POST

Endpoint: /api/GetInventoryTransferReceipt

POST /api/GetInventoryTransferReceipt

Use this API to view the receipt of the transferred inventory.

Request Fields Detail

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

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:

Sample Request Body

{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": ""
}

Response Fields Detail

Fields	Description
InventoryTransferReceiptDetailsModelList array

Fields

Description

InventoryTransferReceiptDetailsModelList

array

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"
      }
    ]
  }
}

InventoryDispatch

Action: POST

Endpoint: /api/InventoryDispatch

POST /api/InventoryDispatch

Use this API to Dispatch Inventory.

Request Fields Detail

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
DispatchDate datetime Mandatory	Date of inventory dispatch Format: yyyy-mm-ddThh:mm:ss Example:2017-09-26T00:00:00
InvoiceNumber string Optional	Invoice Number Valid Values: A-Z 0-9 Example: AB987567757
ShippingMode string Optional	Shipping Method to send cards valid values 0=Standard 1=Priority 2=Overnight Example : 0 Allowable Values: 50
AWBNumber string Optional	Air Way Bill Number of an inventory transfer Valid values: 0-9 Example: 156463 Allowable Values: 50

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:

DispatchDate

datetime

Mandatory

Date of inventory dispatch Format: yyyy-mm-ddThh:mm:ss Example:2017-09-26T00:00:00

InvoiceNumber

string

Optional

Invoice Number Valid Values: A-Z 0-9 Example: AB987567757

ShippingMode

string

Optional

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

Allowable Values:

AWBNumber

string

Optional

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

Allowable Values:

Sample Request Body

{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "OrderID": "190083",
  "DispatchDate": "2023-06-08T14:30:00-04:00",
  "InvoiceNumber": "145654645",
  "ShippingMode": "1",
  "AWBNumber": "1210201901"
}

Response Fields Detail

Fields	Description
OrderID string	Order number for an inventory. Valid values : 0-9 Example : 3478

Fields

Description

OrderID

string

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

Sample Response Body

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

InventoryTransfer

Action: POST

Endpoint: /api/InventoryTransfer

POST /api/InventoryTransfer

Use this API to transfer the inventory from One Branch to Another Branch.

Request Fields Detail

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 Conditional	Order number for an inventory. Valid values : 0-9 Example : 3478 Condition : At least one of Account Number/Card Number/Proxy Number/Order ID is required. Example:3745 Allowable Values: 19
FromBranchCode string Mandatory	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 Mandatory	Branch code of the branch where the card will be received. Valid Values: A-Z, a-z, 0-9 , Example:DC1006
ShippingMode string Mandatory	Shipping Method to send cards,valid values 0=Standard 1=Priority 2=Overnight 3=2nd business day Allowable Values: 50
AutoReceipt string Mandatory	Transfer Receipt should be generated automatically or not. Valid Values: 0 = yes 1 = NO Allowable Values: 1
CardTransferRecords array Optional

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

Conditional

Order number for an inventory. Valid values : 0-9 Example : 3478 Condition : At least one of Account Number/Card Number/Proxy Number/Order ID is required. Example:3745

Allowable Values:

FromBranchCode

string

Mandatory

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

Mandatory

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

ShippingMode

string

Mandatory

Shipping Method to send cards,valid values 0=Standard 1=Priority 2=Overnight 3=2nd business day

Allowable Values:

AutoReceipt

string

Mandatory

Transfer Receipt should be generated automatically or not. Valid Values: 0 = yes 1 = NO

Allowable Values:

CardTransferRecords

array

Optional

Sample Request Body

{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "OrderID": "194496",
  "FromBranchCode": "CC10000",
  "ToBranchCode": "BankA2000",
  "ShippingMode": "0",
  "AutoReceipt": "1",
  "CardTransferRecords": [
    {
      "ProxyNumber": "194475",
      "AccountNumber": "60000000032489"
    }
  ]
}

Response Fields Detail

Fields	Description
OrderID string	Order number for an inventory. Valid values : 0-9 Example : 3478

Fields

Description

OrderID

string

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

Sample Response Body

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

SearchedInventoryDetails

Action: POST

Endpoint: /api/SearchedInventoryDetails

POST /api/SearchedInventoryDetails

Use this API to fetch details of the inventory using orderID.

Request Fields Detail

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

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:

Sample Request Body

{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "OrderID": "194468"
}

Response Fields Detail

Fields	Description
OrderId Int32	Order number for an inventory. Valid values : 0-9 Example : 3478
RequestedOn datetime	Request date time of activity Format: yyyy-mm-ddTHH:mm:ss:msi Example:2017-09-26T00:00:00:000
NumberOfCards decimal	Total number of cards. Valid values: 0-9 Example: 17
OrderStatus 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
BulkShipaddress1 string	Address Line 1 of the cardholder. Valid values: A-Z, a-z, 0-9 Example: 15 Penang Street Point
BulkShipaddress2 string	Address Line 2 of the cardholder. Valid values: A-Z, a-z, 0-9 Example : 1 mecca way
City string	Cardholder's City of residence Valid values: A-Z, a-z, 0-9 Example: Norcross
PostalCode string	Cardholder Postal Code of Residence Valid Values:A-Z,a-z,0-9 Example: 30093
Country string	Two Character Country Code Valid values :A-Z, a-z Example: US Refer Appendix section : Country Code Values
State string	Cardholder State of residence Valid values are A-Z, a-z Example: GA Please refer Appendix Section : State Codes(US)
FICompanyName string	Company name
AttnName string	Attention name, can be used to store additional information.
AcctYesNo string	whether Account number should be printed in embossing file or not. Valid Values : 1 ,2 1= Yes 2= No
SubAgentID string	Sub-Agent ID associated with the Bank for the Card Program-type. Valid Values: A-Z,a-z,0-9 Example:Test123
Title string	Title for the customer Valid Values: Refer Appendix Section : Title Values Example: Mr.
FirstName string	First Name for Shipping address Valid Values: A-Z,a-z. Example: TestName Condition: It is mandatory when value of DifferentShipToAddress =2
MiddleName string	Cardholder Middle Name values are A-Z, a-z, 0-9 Example: Charles
LastName string	Cardholder Last Name Valid values: A-Z, a-z Example: Hudson
NameOnCard string	Name to be Embossed on Card Valid values are A-Z, a-z, 0-9. Example: Hudson M Charles
RequestedBy string	User id of the user who requested the inventory. Example : abc.cc.admin
ProductName string	Name of the Account's Product Valid Values:0-9, A-Z Example: Cash card
ApprovedBy string	UserID of the person who approved the inventory order. Valid Values:0-9, A-Z, a-z Example:abcd.admin
ApprovedOn datetime	Date on which the inventory order was approved Format: yyyy-mm-ddTHH:mm:ss:msi Example:2017-09-26T00:00:00:000
SourceLocation string	Source location of the inventory
DestinationLocation string	Destination Address
AWBNumber string	Indicates the Air Way Bill Number of an inventory transfer Example 156463
DispatchDate datetime	Date of inventory dispatch Format: yyyy-mm-ddThh:mm:ss Example:2017-09-26T00:00:00
InvoiceNumber string	Invoice Number Valid Values: A-Z 0-9 Example: AB987567757
BranchCode string	Branch code from where the card was issued. Valid Values:0-9, A-Z Example:C1006
EmbossingLine4 string	Text to be print on Line 4 of a plastic. Valid Values:a-z, A-Z
ClientName string	Name of the client Valid values: A-Z, a-z, 0-9 Example : FirstSearch
BranchStoreName string	Store Name of the branch Valid values : A-Z Example - head office.
PlasticList array

Sample Response Body

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {
    "OrderId": 194469,
    "RequestedOn": "2020-08-17T00:00:00",
    "NumberOfCards": 9.0,
    "OrderStatus": "Approved",
    "BulkShipaddress1": "Addrress1",
    "BulkShipaddress2": "Addresss2",
    "City": "New York City",
    "PostalCode": "30093",
    "Country": "United States",
    "State": "New York",
    "FICompanyName": "TEST CompanyName",
    "AttnName": "Test Attn",
    "AcctYesNo": "1",
    "SubAgentID": "Test123",
    "Title": "DR.",
    "FirstName": "Gangadhar",
    "MiddleName": "Vidyadhar",
    "LastName": "Shashtri",
    "NameOnCard": "Gangadhar V Shashtri",
    "RequestedBy": "abcd.admin",
    "ProductName": "Convenient Access Visa Prepaid Card - AC155",
    "ApprovedBy": "abcd.admin",
    "ApprovedOn": "2021-02-20T00:00:00",
    "SourceLocation": "Convenient Card Top branch",
    "DestinationLocation": "Convenient Card Top branch",
    "AWBNumber": "156463",
    "DispatchDate": "2021-02-21T00:00:00",
    "InvoiceNumber": "AB987567757",
    "BranchCode": "CC10000",
    "EmbossingLine4": "Access The World",
    "ClientName": "Convenient Cards Inc",
    "BranchStoreName": "Convenient Card Top branch (CC10000)",
    "PlasticList": [
      {
        "Quantity": 2.0,
        "PlasticCode": "002",
        "PlasticDescription": "Red (002)",
        "LogoID": "123"
      },
      {
        "Quantity": 3.0,
        "PlasticCode": "32",
        "PlasticDescription": "Access Card/Valid (32)",
        "LogoID": "456"
      }
    ]
  }
}

SearchInventory

Action: POST

Endpoint: /api/SearchInventory

POST /api/SearchInventory

Use this API to search inventory using parameters like Inventory Status, Order ID, Product ID etc.

Request Fields Detail

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 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
InventoryStatus string Optional	Status of the inventory Valid values : 1= Approval Pending 2 = Approved 3 = Cards Created 4 = Inventory Dispatch 5 = Received 6 = Inventory Received with return 7 = Lost in Transit 8 = Damaged in Transit 9 = Transfer Received 10 = Transfer Received with return 11 = Transfer - In Transit 12 = Transfer - Lost in Transit 13 = Transfer - Damaged in Transit 14 = Error 15 = Rejected Allowable Values: 50
ProductID string Optional	ID of the Account's Product Valid Values:0-9 Example: 1739,1758 Allowable Values: 10
PlasticCode string Optional	Plastic Code Valid values:0-9 Example: 32 Allowable Values: 100
BranchCode string Optional	Code assigned to branch from where the card was issued. Valid Values:0-9, A-Z Example:C1006 Allowable Values: 20
AccountNumber string Optional	Account Number of the cardholder. Valid values: 0-9 Example: 2000000000000396893 Allowable Values: 19
ProxyNumber string Optional	Proxy Number of the cardholder Valid values:0-9 Example:1005 Allowable Values: 19
OrderRequestDate string Optional	Date of requesting order Format:mm/dd/yyyy Example:09/26/2020 Allowable Values: 10
CreateDate string Optional	Date of order creation Format:mm/dd/yyyy Example:09/26/2020 Allowable Values: 10
NumberOfCard string Optional	Total number of cards. Valid values: 0-9 Example: 17 Allowable Values: 10
CardNumber string Optional	Clear Card Number of the cardholder Valid values: 0-9 Example: 123456****0001 Allowable Values:** 16

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

Optional

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

Allowable Values:

ClientID

string

Optional

Client Id Valid Values: 1422245 Format:XXXXX

Allowable Values:

InventoryStatus

string

Optional

Status of the inventory Valid values : 1= Approval Pending 2 = Approved 3 = Cards Created 4 = Inventory Dispatch 5 = Received 6 = Inventory Received with return 7 = Lost in Transit 8 = Damaged in Transit 9 = Transfer Received 10 = Transfer Received with return 11 = Transfer - In Transit 12 = Transfer - Lost in Transit 13 = Transfer - Damaged in Transit 14 = Error 15 = Rejected

Allowable Values:

ProductID

string

Optional

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

Allowable Values:

PlasticCode

string

Optional

Plastic Code Valid values:0-9 Example: 32

Allowable Values:

100

BranchCode

string

Optional

Code assigned to branch from where the card was issued. Valid Values:0-9, A-Z Example:C1006

Allowable Values:

AccountNumber

string

Optional

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

Allowable Values:

ProxyNumber

string

Optional

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

Allowable Values:

OrderRequestDate

string

Optional

Date of requesting order Format:mm/dd/yyyy Example:09/26/2020

Allowable Values:

CreateDate

string

Optional

Date of order creation Format:mm/dd/yyyy Example:09/26/2020

Allowable Values:

NumberOfCard

string

Optional

Total number of cards. Valid values: 0-9 Example: 17

Allowable Values:

CardNumber

string

Optional

Clear Card Number of the cardholder Valid values: 0-9 Example: 123456******0001

Allowable Values:

Sample Request Body

{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "OrderID": "1316728",
  "ClientID": "",
  "InventoryStatus": "1",
  "ProductID": "1739",
  "PlasticCode": "",
  "BranchCode": "CC1000",
  "AccountNumber": "60000000025889",
  "ProxyNumber": "1316182",
  "OrderRequestDate": "12/30/2020",
  "CreateDate": "08/24/2020",
  "NumberOfCard": "3",
  "CardNumber": "4066846120009716"
}

Response Fields Detail

Fields	Description
SearchInventoryList array

Fields

Description

SearchInventoryList

array

Sample Response Body

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {
    "SearchInventoryList": [
      {
        "OrderId": 194467,
        "RequestedOn": "8/17/2020 3:30:32 PM",
        "NumberOfCard": 3,
        "InventoryStatus": "Transfer - in Transit",
        "RequestedBy": "ccadmin",
        "ProductName": "Convenient Access Visa Prepaid Card - AC155",
        "MultiplePlastic": "Yes",
        "BranchStoreName": "Convenient Card Top branch (CC10000)"
      }
    ]
  }
}

UpdateInventoryReceipt

Action: POST

Endpoint: /api/UpdateInventoryReceipt

POST /api/UpdateInventoryReceipt

Use this API to Update the Inventory Receipt Status.

Request Fields Detail

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 Detail

Fields	Description

Sample Response Body

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