Core Card Api Quick Start

Request Stock

Action: POST

Endpoint: /api/CoreCredit/AccountHolders/RequestStock

Use this API to create accounts in bulk in the CoreCard system to create an inventory of the cards. New accounts may be created under a specific product or partner (StoreID).

Request fields details

Fields	Description
Source string	Source of API Consumer For external system expected sources will be WEB. Allowable Values: 50
IPAddress string Optional	IP Address of Client / Application Hosting Server Example: 10.206.0.204 Allowable Values: 15
DateFormat string Optional	Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS Allowable Values: 25
CurrencyCode string Optional	Place Holder for Future Use. Currency Code Ex. 840 = US Doller. Allowable Values: 10
CurrencySymbolType string Optional	Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD Allowable Values: 10
Language string Optional	Place Holder for Future Use. Language == en: means use English ---- es: means Spanish Allowable Values: 10
ExternalIP string	IP Address of end user of API Allowable Values: 50
SessionID string Optional	Session identifier of the API Example: 000028;026;1349906692 Allowable Values: 100
APIVersion string	Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0
CallerID string Optional	Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR) Allowable Values: 20
CalledID string Optional	Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR) Allowable Values: 20
RequestTime datetime Optional	Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23
InstitutionID integer Mandatory	Unique identification number for Institution Valid Values:0-9 Format:XXXX Example:Fixed value needs to pass which is provided by Corecard.
ProductID integer Mandatory	ID assigned to a Program Valid Values:0-9 Format:XXXX Example:Fixed value provided by CoreCard.
MerchantID integer Optional	Unique number of merchant account Valid Values:0-9 Format:XXXXX Example:12345
StoreID string Mandatory	ID of the Store Valid Values: 0-9 Example:1234 Condition:Core Card will provide the value for this field after the Program is setup.
HoldEmbossing string Mandatory	Hold embossing indicator. Valid Values: 1= YES, 0 = NO Allowable Values: 2
DeliveryMechanism string Optional	Delivery Mechanism(Overnight, Priority or Standard). Valid Values: 0 -for Standard ,1 -for Priority , 2 -for Overnight Condition: Delivery mechanism is optional. Allowable Values: 5
NumberofCard integer Mandatory	Embossing quantity for request made. Valid Values:0-9 Format:XX Example:02
Title string Optional	Title of Person to whom stock is shipped. Format: A-Z Example:Mr Allowable Values: 10
FirstName string Optional	First name of Person to whom stock is shipped. Valid Values:A-Z Example:User1 Allowable Values: 50
MiddleName string Optional	Middle Name of Person to whom stock is shipped. Valid Values: A-Z Example: LEE Allowable Values: 50
LastName string Optional	Last name of Person to whom stock is shipped. Valid Values:A-Z Example:Smith Allowable Values: 50
NameOnCard string Optional	Name to be printed on the card. Valid Values:A-Z, 0-9 Format:XXXX Example:John J Allowable Values: 50
EmbossingLine4 string Optional	Embossing line4 Allowable Values: 50
ShippingAddressLine1 string Optional	Shipping address line 1 Valid Values:A-Z, 0-9 Example:123 HWY Allowable Values: 50
ShippingAddressLine2 string Optional	Shipping address line 2. Valid Values:A-Z, 0-9 Example:Park Avenue Allowable Values: 50
ShippingCity string Optional	Shipping address city name. Example:Los Angeles Allowable Values: 40
ShippingState string Optional	Sate of the shipping address. Example:Virginia Allowable Values: 40
ShippingPostalCode string Optional	Zip code of the shipping address. Valid Values:0-9 Example:46206 Allowable Values: 9
ShippingCountry string Optional	Shipping address Country name Valid Values: 0-9, A-Z Format: XXXXXXXXXX Example: USA Allowable Values: 3
Source string Mandatory	Source of API Consumer For external system expected sources will be WEB. Allowable Values: 50
IPAddress string Optional	IP Address of Client / Application Hosting Server Example: 10.206.0.204 Allowable Values: 15
DateFormat string Optional	Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS Allowable Values: 25
CurrencyCode string Optional	Currency Code Place Holder for Future Use. Valid Values: Refer Appendix Section - Currency Code Example:840 = US Dollar Condition:If no value is passed, default value = 840 Allowable Values: 10
CurrencySymbolType string Optional	Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD Allowable Values: 10
Language string Optional	Place Holder for Future Use. Language: en: means use English Default: en - English Allowable Values: 10
ExternalIP string Mandatory	IP Address of end user of API Allowable Values: 50
SessionID string Optional	Session identifier of the API Example: 000028;026;1349906692 Allowable Values: 100
APIVersion string Mandatory	Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0 Allowable Values: 10
CallerID string Optional	Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR) Allowable Values: 20
CalledID string Optional	Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR) Allowable Values: 20
RequestTime datetime Optional	Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23
InstitutionID integer Optional	Unique identification number for Institution Valid Values:0-9 Format:XXXX Example:Fixed value needs to pass which is provided by Corecard.
ProductID integer Optional	ID assigned to a Program Valid Values:0-9 Format:XXXX Example:Fixed value provided by CoreCard.
MerchantID integer Optional	Unique number of merchant account Valid Values:0-9 Format:XXXXX Example:12345
StoreID string Optional	ID of the Store Valid Values: 0-9 Example:1234 Condition:Core Card will provide the value for this field after the Program is setup.
HoldEmbossing string Optional	Hold embossing indicator. Valid Values: 1= YES, 0 = NO Allowable Values: 2
DeliveryMechanism string Optional	Delivery Mechanism(Overnight, Priority or Standard). Valid Values: 0 -for Standard ,1 -for Priority , 2 -for Overnight Condition: Delivery mechanism is optional. Allowable Values: 5
NumberofCard integer Optional	Embossing quantity for request made. Valid Values:0-9 Format:XX Example:02
Title string Optional	Title of Person to whom stock is shipped. Format: A-Z Example: Refer Appendix Section 5.7 Allowable Values: 5
FirstName string Optional	First name of Person to whom stock is shipped. Valid Values:A-Z Example:User1 Allowable Values: 40
MiddleName string Optional	Middle Name of Person to whom stock is shipped. Valid Values: A-Z Example: LEE Allowable Values: 10
LastName string Optional	Last name of Person to whom stock is shipped. Valid Values:A-Z Example:Smith Allowable Values: 40
NameOnCard string Optional	Name to be printed on the card. Valid Values:A-Z, 0-9 Format:XXXX Example:John J Allowable Values: 50
EmbossingLine4 string Optional	Place holder on Embossing. Valid Values:A-Z, 0-9 Format:XXXX Example: Embossing Info Allowable Values: 20
ShippingAddressLine1 string Optional	Shipping address line 1 Valid Values:A-Z, 0-9 Example:123 HWY Allowable Values: 50
ShippingAddressLine2 string Optional	Shipping address line 2. Valid Values:A-Z, 0-9 Example:Park Avenue Allowable Values: 50
ShippingCity string Optional	Shipping address city name. Example:Los Angeles Allowable Values: 40
ShippingState string Optional	Sate of the shipping address. Example:Virginia Allowable Values: 40
ShippingPostalCode string Optional	Zip code of the shipping address. Valid Values:0-9 Example:46206 Allowable Values: 9
ShippingCountry string Optional	Shipping address Country name Valid Values: 0-9, A-Z Format: XXXXXXXXXX Example: USA Allowable Values: 3

Fields

Description

Source

string

Source of API Consumer For external system expected sources will be WEB.

Allowable Values:

IPAddress

string

Optional

IP Address of Client / Application Hosting Server Example: 10.206.0.204

Allowable Values:

DateFormat

string

Optional

Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS

Allowable Values:

CurrencyCode

string

Optional

Place Holder for Future Use. Currency Code Ex. 840 = US Doller.

Allowable Values:

CurrencySymbolType

string

Optional

Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD

Allowable Values:

Language

string

Optional

Place Holder for Future Use. Language == en: means use English ---- es: means Spanish

Allowable Values:

ExternalIP

string

IP Address of end user of API

Allowable Values:

SessionID

string

Optional

Session identifier of the API Example: 000028;026;1349906692

Allowable Values:

100

APIVersion

string

Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0

CallerID

string

Optional

Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR)

Allowable Values:

CalledID

string

Optional

Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR)

Allowable Values:

RequestTime

datetime

Optional

Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23

InstitutionID

integer

Mandatory

Unique identification number for Institution Valid Values:0-9 Format:XXXX Example:Fixed value needs to pass which is provided by Corecard.

ProductID

integer

Mandatory

ID assigned to a Program Valid Values:0-9 Format:XXXX Example:Fixed value provided by CoreCard.

MerchantID

integer

Optional

Unique number of merchant account Valid Values:0-9 Format:XXXXX Example:12345

StoreID

string

Mandatory

ID of the Store Valid Values: 0-9 Example:1234 Condition:Core Card will provide the value for this field after the Program is setup.

HoldEmbossing

string

Mandatory

Hold embossing indicator. Valid Values: 1= YES, 0 = NO

Allowable Values:

DeliveryMechanism

string

Optional

Delivery Mechanism(Overnight, Priority or Standard). Valid Values: 0 -for Standard ,1 -for Priority , 2 -for Overnight Condition: Delivery mechanism is optional.

Allowable Values:

NumberofCard

integer

Mandatory

Embossing quantity for request made. Valid Values:0-9 Format:XX Example:02

Title

string

Optional

Title of Person to whom stock is shipped. Format: A-Z Example:Mr

Allowable Values:

FirstName

string

Optional

First name of Person to whom stock is shipped. Valid Values:A-Z Example:User1

Allowable Values:

MiddleName

string

Optional

Middle Name of Person to whom stock is shipped. Valid Values: A-Z Example: LEE

Allowable Values:

LastName

string

Optional

Last name of Person to whom stock is shipped. Valid Values:A-Z Example:Smith

Allowable Values:

NameOnCard

string

Optional

Name to be printed on the card. Valid Values:A-Z, 0-9 Format:XXXX Example:John J

Allowable Values:

EmbossingLine4

string

Optional

Embossing line4

Allowable Values:

ShippingAddressLine1

string

Optional

Shipping address line 1 Valid Values:A-Z, 0-9 Example:123 HWY

Allowable Values:

ShippingAddressLine2

string

Optional

Shipping address line 2. Valid Values:A-Z, 0-9 Example:Park Avenue

Allowable Values:

ShippingCity

string

Optional

Shipping address city name. Example:Los Angeles

Allowable Values:

ShippingState

string

Optional

Sate of the shipping address. Example:Virginia

Allowable Values:

ShippingPostalCode

string

Optional

Zip code of the shipping address. Valid Values:0-9 Example:46206

Allowable Values:

ShippingCountry

string

Optional

Shipping address Country name Valid Values: 0-9, A-Z Format: XXXXXXXXXX Example: USA

Allowable Values:

Source

string

Mandatory

Source of API Consumer For external system expected sources will be WEB.

Allowable Values:

IPAddress

string

Optional

IP Address of Client / Application Hosting Server Example: 10.206.0.204

Allowable Values:

DateFormat

string

Optional

Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS

Allowable Values:

CurrencyCode

string

Optional

Currency Code Place Holder for Future Use. Valid Values: Refer Appendix Section - Currency Code Example:840 = US Dollar Condition:If no value is passed, default value = 840

Allowable Values:

CurrencySymbolType

string

Optional

Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD

Allowable Values:

Language

string

Optional

Place Holder for Future Use. Language: en: means use English Default: en - English

Allowable Values:

ExternalIP

string

Mandatory

IP Address of end user of API

Allowable Values:

SessionID

string

Optional

Session identifier of the API Example: 000028;026;1349906692

Allowable Values:

100

APIVersion

string

Mandatory

Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0

Allowable Values:

CallerID

string

Optional

Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR)

Allowable Values:

CalledID

string

Optional

Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR)

Allowable Values:

RequestTime

datetime

Optional

Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23

InstitutionID

integer

Optional

Unique identification number for Institution Valid Values:0-9 Format:XXXX Example:Fixed value needs to pass which is provided by Corecard.

ProductID

integer

Optional

ID assigned to a Program Valid Values:0-9 Format:XXXX Example:Fixed value provided by CoreCard.

MerchantID

integer

Optional

Unique number of merchant account Valid Values:0-9 Format:XXXXX Example:12345

StoreID

string

Optional

ID of the Store Valid Values: 0-9 Example:1234 Condition:Core Card will provide the value for this field after the Program is setup.

HoldEmbossing

string

Optional

Hold embossing indicator. Valid Values: 1= YES, 0 = NO

Allowable Values:

DeliveryMechanism

string

Optional

Delivery Mechanism(Overnight, Priority or Standard). Valid Values: 0 -for Standard ,1 -for Priority , 2 -for Overnight Condition: Delivery mechanism is optional.

Allowable Values:

NumberofCard

integer

Optional

Embossing quantity for request made. Valid Values:0-9 Format:XX Example:02

Title

string

Optional

Title of Person to whom stock is shipped. Format: A-Z Example: Refer Appendix Section 5.7

Allowable Values:

FirstName

string

Optional

First name of Person to whom stock is shipped. Valid Values:A-Z Example:User1

Allowable Values:

MiddleName

string

Optional

Middle Name of Person to whom stock is shipped. Valid Values: A-Z Example: LEE

Allowable Values:

LastName

string

Optional

Last name of Person to whom stock is shipped. Valid Values:A-Z Example:Smith

Allowable Values:

NameOnCard

string

Optional

Name to be printed on the card. Valid Values:A-Z, 0-9 Format:XXXX Example:John J

Allowable Values:

EmbossingLine4

string

Optional

Place holder on Embossing. Valid Values:A-Z, 0-9 Format:XXXX Example: Embossing Info

Allowable Values:

ShippingAddressLine1

string

Optional

Shipping address line 1 Valid Values:A-Z, 0-9 Example:123 HWY

Allowable Values:

ShippingAddressLine2

string

Optional

Shipping address line 2. Valid Values:A-Z, 0-9 Example:Park Avenue

Allowable Values:

ShippingCity

string

Optional

Shipping address city name. Example:Los Angeles

Allowable Values:

ShippingState

string

Optional

Sate of the shipping address. Example:Virginia

Allowable Values:

ShippingPostalCode

string

Optional

Zip code of the shipping address. Valid Values:0-9 Example:46206

Allowable Values:

ShippingCountry

string

Optional

Shipping address Country name Valid Values: 0-9, A-Z Format: XXXXXXXXXX Example: USA

Allowable Values:

Sample request body

{
  "Source": "Web",
  "IPAddress": "10.120.0.1",
  "DateFormat": null,
  "CurrencyCode": null,
  "CurrencySymbolType": null,
  "Language": null,
  "ExternalIP": "10.120.0.0",
  "SessionID": null,
  "APIVersion": "2.0",
  "CallerID": null,
  "CalledID": null,
  "RequestTime": null,
  "InstitutionID": 1320,
  "ProductID": null,
  "MerchantID": 7010,
  "StoreID": "7020",
  "HoldEmbossing": "1",
  "DeliveryMechanism": "0",
  "NumberofCard": 10,
  "Title": null,
  "FirstName": null,
  "MiddleName": null,
  "LastName": null,
  "NameOnCard": null,
  "EmbossingLine4": null,
  "ShippingAddressLine1": null,
  "ShippingAddressLine2": null,
  "ShippingCity": null,
  "ShippingState": null,
  "ShippingPostalCode": null,
  "ShippingCountry": null
}

Response fields details

Fields	Description
OrderID integer	Order ID Valid Values:0-9 Format:XXXX
RequestID integer	Request ID Valid Values:0-9 Format:XXXX
ResponseID string	This number indicates that API responded. Response ID is unique. This value will be null if no authentication information was passed. Response ID can be used for tracking. Valid Values:0-9,a-z Allowable Values: 15
RecordType integer	Record Type
ProductType integer	Product Type Valid Values:0-9 Format:XXXX
FirstName string	Card holder's First name. Valid Values:A-Z Example:User1 Allowable Values: 50
MiddleName string	Card holder's Middle Name. Valid Values: A-Z Example: LEE Allowable Values: 50
LastName string	Card holder's last name. Valid Values:A-Z Example:Smith Allowable Values: 50
AccountNumber string	Account number of cardholder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Allowable Values: 19
CustomerID string	Customer ID of Cardholder assigned to a Program Valid Values:0-9 Format:XXXX
AccountCreationDate datetime	Account Creation Date
AccountCreationTime datetime	Time of Account Creation
TerminalID string	TerminalID Allowable Values: 50
EmailID string	Card holder Email ID Valid Values:0-9 Format:XXX@xx.com Example:ABC@gmail.com Allowable Values: 300
ManualStatus string	Status of account assigned manually Valid Values: Active, Closed etc. Format:XXXX Example:Active Allowable Values: 15
GeneratedStatus string	Generated status based on Account Status, Card Manual Status and Embossing Status. Valid Values:Possible values - Active,Blocked etc Format:XXXX Example:Possible values - Active,Blocked etc Allowable Values: 250
UniversalUniqueID string	ID assigned to a Program Valid Values:0-9 Format:XXXX Example:Fixed value provided by CoreCard. Allowable Values: 64
BulkCardUUID string	ID assigned to a Program Valid Values:0-9 Format:XXXX Example:Fixed value provided by CoreCard. Allowable Values: 64
OrderID integer	Order ID Valid Values:0-9 Format:XXXX
RequestID integer	Request ID Valid Values:0-9 Format:XXXX
ResponseID string	This number indicates that API responded. Response ID is unique. This value will be null if no authentication information was passed. Response ID can be used for tracking. Valid Values:0-9,a-z Allowable Values: 15
MiddleName string	Card holder's Middle Name. Valid Values: A-Z Example: LEE Allowable Values: 10

Fields

Description

OrderID

integer

Order ID Valid Values:0-9 Format:XXXX

RequestID

integer

Request ID Valid Values:0-9 Format:XXXX

ResponseID

string

This number indicates that API responded. Response ID is unique. This value will be null if no authentication information was passed. Response ID can be used for tracking. Valid Values:0-9,a-z

Allowable Values:

RecordType

integer

Record Type

ProductType

integer

Product Type Valid Values:0-9 Format:XXXX

FirstName

string

Card holder's First name. Valid Values:A-Z Example:User1

Allowable Values:

MiddleName

string

Card holder's Middle Name. Valid Values: A-Z Example: LEE

Allowable Values:

LastName

string

Card holder's last name. Valid Values:A-Z Example:Smith

Allowable Values:

AccountNumber

string

Account number of cardholder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404

Allowable Values:

CustomerID

string

Customer ID of Cardholder assigned to a Program Valid Values:0-9 Format:XXXX

AccountCreationDate

datetime

Account Creation Date

AccountCreationTime

datetime

Time of Account Creation

TerminalID

string

TerminalID

Allowable Values:

EmailID

string

Card holder Email ID Valid Values:0-9 Format:XXX@xx.com Example:ABC@gmail.com

Allowable Values:

300

ManualStatus

string

Status of account assigned manually Valid Values: Active, Closed etc. Format:XXXX Example:Active

Allowable Values:

GeneratedStatus

string

Generated status based on Account Status, Card Manual Status and Embossing Status. Valid Values:Possible values - Active,Blocked etc Format:XXXX Example:Possible values - Active,Blocked etc

Allowable Values:

250

UniversalUniqueID

string

ID assigned to a Program Valid Values:0-9 Format:XXXX Example:Fixed value provided by CoreCard.

Allowable Values:

BulkCardUUID

string

ID assigned to a Program Valid Values:0-9 Format:XXXX Example:Fixed value provided by CoreCard.

Allowable Values:

OrderID

integer

Order ID Valid Values:0-9 Format:XXXX

RequestID

integer

Request ID Valid Values:0-9 Format:XXXX

ResponseID

string

This number indicates that API responded. Response ID is unique. This value will be null if no authentication information was passed. Response ID can be used for tracking. Valid Values:0-9,a-z

Allowable Values:

MiddleName

string

Card holder's Middle Name. Valid Values: A-Z Example: LEE

Allowable Values:

Sample response body

{
  "Message": "Order request created successfully",
  "Status": true,
  "ErrorCode": "ERR01121",
  "ResponseData": {
    "OrderID": 1002,
    "RequestID": 1002,
    "ResponseID": "56806634",
    "MiddleName": null
  }
}