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

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.

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

Quantity

decimal

Number of cards ordered in inventory Valid values : 0-9 Example : 850

PlasticCode

string

Plastic Code Valid values: 0-9 Example: 32

PlasticDescription

string

Name of the plastic card.

LogoID

string

Logo ID printed on the cards. Valid value: 0-9, A-Z Example : Cash187