Category links

API Links

New Cards

When an issuer uses the CoreCard system for creating and activating an account, the customer's information is linked to the account. You can use the CoreCard system to generate a new card number and issue that number to the customer. The card number is unique and will be linked to a specific account number. If a customer completes monetary transactions using the card issued for an account, those transactions would be recorded for that account and that card. You can use CoreCard APIs to generate the cards in digital as well as physical form. 

There are three main types of cards that can be issued using the CoreCard system:

Primary Card: This card is issued to the main or primary account holder and can be a physical or digital card. You can generate the primary card during account creation (see the AccountCreation API). 


Secondary Card: The secondary card is a physical or digital card usually issued to a secondary cardholder at the primary account holder's request (see the CreateSecondaryCard API). The secondary card may have the same rights as the primary card. The primary cardholder can control attributes and account accessibility for the secondary cardholder.
 

Virtual Card: This card can be created virtually at an account holder's request for a predefined use limit. Depending on the requirement, the primary cardholder can define the attributes of the virtual card using CoreCard API (see the CreateVirtualCard API).

Create Virtual Card

Action: POST

Endpoint: /api/CoreCredit/AccountHolders/CreateVirtualCard

POST /api/CoreCredit/AccountHolders/CreateVirtualCard

Use this API to create virtual cards and assign the attribute such as card limit, expiry option & expiry date.

Request fields detail
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 Default: en - English

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

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

AccountNumber

string

Conditional

Account number of Card holder under which secondary card need to be created. Valid Values:0-9 Example:8000000000000037 Condition:Any one from Admin Number or Account Number is mandatory

Allowable Values:

19

AdminNumber

int64

Conditional

Details can be obtained by admin number (Embossing Acctid). Valid Values:0-9 Format:XXXXX Example:12345 Condition:Any one from Admin Number or Account Number is mandatory

VirtualCardLimit

decimal

Conditional

Card limit of Virtual card Valid Values:0-9 Format:XXXX.XX Example:1000.00 Condition:This field is conditional. Virtual Card can be created without passing Virtual card limit, It can be 0 or Null.If it is 0 or Null then card will use Accounts Credit Limit.

VirtualCardResetAllow

integer

Mandatory

Flag to decide if created virtual card should get the facility to update card limit. Valid Values: 0 = Yes (Will get the facility to update card limit) 1 = No (Will not get the facility to update card limit) Format:X Example:0,1

VirtualCardExpOption

integer

Mandatory

Virtual card expiration option. Valid Values: 0 = Card expire after no.of transactions. 1 = Card expire on particular duration. 2 = Card expire on particular date. 3 = Card expiry date is same as Primary Card. This field is mandatory when Secondary Card Type is "1"(Virtual). Format: X Example: 2 (Card expire on particular date)

VirtualCardExpAfterTxn

integer

Conditional

Virtual card expiration option after certain number of transaction. Valid Values: 0-9 Format: XX Example: 10 Condition: This field is mandatory when VirtualCardExpOption is 0 (Card expire after no. of transactions)

VirtualCardExpDuration

integer

Conditional

Virtual card expiration duration like hour, minute, day etc Valid Values: 0 = Minutes 1 = Hour 2 = Day 3 = Week 4 = Month 5 = Year Format: X Example: 2 (Day) Condition: This field is mandatory when VirtualCardExpOption = 1 (Card expire on particular duration)

VirtualCardExpDurationValue

integer

Conditional

Virtual card expiration Duration Value. Valid Values: 0-9 Format: XXX Example: Virtual Card Expiry duration is 4(month) then this field value can be of 1-12. Condition: This field is mandatory when VirtualCardExpOption = 1 (Card expire on particular duration)

VirtualCardExpDate

datetime

Conditional

Virtual card expiration option at exact date. Valid Values: 0-9 Format: MM/DD/YYYY Example: 01/01/2024 Condition: This field is mandatory when VirtualCardExpOption is 2 (Card expire on particular date)

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,
  "AccountNumber": "9000000500000170",
  "AdminNumber": 129408,
  "VirtualCardLimit": 1000.0,
  "VirtualCardResetAllow": 0,
  "VirtualCardExpOption": 3,
  "VirtualCardExpAfterTxn": null,
  "VirtualCardExpDuration": null,
  "VirtualCardExpDurationValue": null,
  "VirtualCardExpDate": null
}
Response fields detail
Fields Description

VirtualCardNumber

string

Virtual Card Number Valid Values: 0-9 Format:XXXXXXXXXXXXXXXX Example:1236547896325874

Allowable Values:

19

AccountNumber

string

Account number of Card holder under which secondary card created. Valid Values:0-9 Format:XXXXXXXXXXXXXXXX Example:8000000000000037

Allowable Values:

19

AdminNumber

int64

Details can be obtained by admin number (Embossing Acctid). Valid Values:0-9 Format:XXXXX Example:12345

CurrentCardBalance

decimal

Available Balance of Card. Valid Values:0-9 Format:XXX.XX Example:2000.00

FirstName

string

Card holder's First name. Example:John

Allowable Values:

50

LastName

string

Card holder's last name. Example:Smith

Allowable Values:

50

NameOnCard

string

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

Allowable Values:

50

PrimaryCardExpiryDate

datetime

Expiry date of primary card under which secondary card is being created. Valid Values:0-9 Format: MM/DD/YYYY HH:MM:SS Example: 01/01/2020 11:05:05

ValidFrom

datetime

Card Creation Date of requested card. Format:MM/dd/yyyy HH:mm:ss Example:01/01/2020

ValidTo

datetime

Card Expiration Date of requested card. Format:MM/dd/yyyy HH:mm:ss Example:01/01/2022

CVC

string

3 Digit security number printed on back side of the card. Valid Values:0-9 Format:XXX Example:456

Allowable Values:

3

VirtualCardExpirationDate

datetime

Card Expiration Date of Virtual card. Valid Values: 0-9 Format: MM/DD/YYYY HH:MM:SS Example: 01/01/2020 11:05:05

Sample response body

{
  "application/json": {
    "Message": "Card created successfully.",
    "Status": true,
    "ErrorCode": "ERR01070",
    "ResponseData": {
      "VirtualCardNumber": "XXXXXXXXXXXXXXXX",
      "AccountNumber": "7000000000000146",
      "AdminNumber": 129475,
      "CurrentCardBalance": 1000.0,
      "FirstName": "John",
      "LastName": "Miller",
      "NameOnCard": "John Miller",
      "PrimaryCardExpiryDate": "11/02/2022 00:00:00",
      "ValidFrom": "11/02/2020 00:00:00",
      "ValidTo": "11/02/2022 00:00:00",
      "CVC": "XXX",
      "VirtualCardExpirationDate": "11/02/2020 00:00:00"
    }
  }
}

Create Secondary Card

Action: POST

Endpoint: /api/CoreCredit/AccountHolders/CreateSecondaryCard

POST /api/CoreCredit/AccountHolders/CreateSecondaryCard

The CreateSecondaryCard API creates a secondary or virtual card in a single step. Certain information is required depending upon the card type, such as cardholder details, a shipping address, and card expiry date (if applicable).

Request fields detail
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 Default: en - English

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

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

AccountNumber

string

Conditional

Account number of Card holder under which secondary card need to be created. Valid Values: 0-9 Format: XXXXXXXXXXXXXXXX Example: 8000000000000037 Condition: Any one from Admin Number or Account Number is mandatory

Allowable Values:

19

AdminNumber

int64

Conditional

Details can be obtained by admin number (Embossing Acctid). Valid Values:0-9 Format:XXXXX Example:12345 Condition:Any one from Admin Number or Account Number is mandatory

SecondaryCardType

string

Mandatory

Type of Secondary Card. Valid Values: 0 -Regular Secondary Card 1- Virtual Card

Allowable Values:

25

Title

string

Optional

Title of the cardholder. Example: Mr

Allowable Values:

5

FirstName

string

Conditional

Card holder's First name. Example:John Condition:Required only when HoldEmbossing tag value is 0(NO), means physical card need to be generate

Allowable Values:

40

MiddleName

string

Optional

Card holder's Middle Name. Example: LEE

Allowable Values:

10

LastName

string

Conditional

Card holder's Last Name. Valid Values:A-Z Example:Smith Condition: Required only when HoldEmbossing tag value is 0(NO), means physical card need to be generate

Allowable Values:

40

SurnameSuffix

string

Optional

Cardholder's surname-suffix. Valid Values:Sr/Jr Example:Sr

Allowable Values:

25

DateOfBirth

datetime

Conditional

Card Holder's Date of Birth Valid Values: 0-9 Format: MM/DD/YYYY Example: 02012020 Condition: Required only when SecondaryCardType = 0(Regular Secondary Card)

AddressLine1

string

Conditional

Card Holder's address line 1. Valid Values:A-Z, 0-9 Format: Example:123 HWY Condition: Required only when SecondaryCardType = 0(Regular Secondary Card)

Allowable Values:

50

AddressLine2

string

Conditional

Card holder's address line 2. Valid Values: A-Z, 0-9 Format: Example:Park Avenue Condition: Required only when SecondaryCardType = 0(Regular Secondary Card)

Allowable Values:

50

City

string

Conditional

City name of the Card holder's address. Example: Los Angeles Condition: Required only when SecondaryCardType = 0(Regular Secondary Card)

Allowable Values:

35

Country

string

Conditional

Country name of the Card holder's address Condition: Required only when SecondaryCardType = 0(Regular Secondary Card)

Allowable Values:

25

PostalCode

string

Conditional

Postal code of the card holder's address. Valid Values:0-9 Format:XXXXX Example:46206 Condition: Required only when SecondaryCardType = 0(Regular Secondary Card)

Allowable Values:

9

State

string

Conditional

State of the card holder address. Format:XXXXX Example: Virginia Condition: Required only when SecondaryCardType = 0(Regular Secondary Card)

Allowable Values:

30

ShippingAddressFlag

integer

Optional

Shipping address is existing or new. Valid Values:0,1,2 Format:X Example: 0 = Ship to Existing Address, 1 = Ship Address,2 = Primary Shipping Address Condition: Default value would be 2 = Primary Shipping Address

HomePhoneNumber

string

Conditional

Card holder Home Phone number. Valid Values:0-9 Format:XXXXXXXXXX Example:7895463214 Condition: Required only when SecondaryCardType = 0(Regular Secondary Card)

Allowable Values:

20

WorkPhoneNumber

string

Optional

Card holder Work phone number. Valid Values:0-9 Format:XXXXXXXXXXX Example:5678909876

Allowable Values:

19

MobilePhoneNumber

string

Optional

Card holder Mobile Phone Number. Valid Values:0-9 Format:XXXXXXXXXX Example:987567757

Allowable Values:

15

MobileCarrier

string

Optional

Carrier of Mobile Phone number. Valid Values:a-z,0-9 Format:XXXXXX Example: T-Mobile

Allowable Values:

50

LanguageIndicator

string

Optional

Language Indicator.

Allowable Values:

50

EmailID

string

Optional

Card Holder's email Address Format: XXX @xx.com Example:ABC @gmail.com Condition: Required only when SecondaryCardType = 0(Regular Secondary Card)

Allowable Values:

50

SSN

string

Optional

Card holder's Social Security Number. Format:AAAGGSSSS Example:078051120

Allowable Values:

9

IDNumber

string

Conditional

Card holder's Government ID Number. Format:AAAGGSSSS Example: 078051120 Condition: Required only when SecondaryCardType = 0 (Regular Secondary Card)

Allowable Values:

50

MotherMaidenName

string

Optional

Card holder's mother Maiden Name. Valid ValuesA-Z, 0-9 Format:XXXX Example:Theresa

Allowable Values:

50

IDTypeCode

integer

Conditional

Government issued identification Type.Id Type Code should be passed in the request and not the description. Valid Values: 02- Driver’s license # 03- Matricular # 04- Passport 05- Visa 06- Green Card 07- State ID 08- Military ID 09- Voters Registration Card 10- government ID 11- Tax identification number Example:05 Condition: Required only when SecondaryCardType = 0(Regular Secondary Card)

IDIssueDate

datetime

Conditional

Issue date of ID card. Valid Values:0-9 Format:MM/DD/YYYY Example:02/01/2020 Condition: Required only when SecondaryCardType = 0 (Regular Secondary Card)

IDExpirationDate

datetime

Conditional

Government issued identification expiration date. Valid Values:MM/DD/YYYY Example:02/01/2020 Condition:Required only when SecondaryCardType = 0 (Regular Secondary Card)

IDCountry

string

Conditional

Country of Identification proof. Valid Values:a-z, 0-9 Example: Canada Condition: Required only when SecondaryCardType = 0 (Regular Secondary Card)

Allowable Values:

50

IDIssueState

string

Conditional

State of Identification proof Valid Values:a-z, 0-9 Example: AL Condition: Required only when SecondaryCardType = 0 (Regular Secondary Card)

Allowable Values:

50

NameOnCard

string

Optional

Name to be printed on the card. Valid Values:A-Z, 0-9 Example:John J Condition:If not given then First Name + Last Name will be printed

Allowable Values:

50

EmbossingLine4

string

Optional

Embossing line4.

Allowable Values:

20

HoldEmbossing

integer

Optional

Hold Embossing indicator Valid Values:1= YES, 0 = NO Format: X Example: 1

CardImageID

string

Optional

This is the card image type number which is already decided for embossing them. Valid Values:0-9 Format:XX Example:12

Allowable Values:

50

NameOnTrack

string

Optional

Name on Track echo in embossing file.

Allowable Values:

26

ActivationCode

string

Optional

Code which is provided at the time of Account Creation/Registration should be pass as a user validation.

Allowable Values:

50

ClientID

string

Optional

Indicate Client Id and echo in embossing file Valid Values: 1422245 Format:XXXXX Example: 5558547

Allowable Values:

50

VirtualCardExpOption

string

Conditional

Virtual card expiration option. Valid Values: 0 = Card expire after no.of transactions. 1 = Card expire on particular duration. 2 = Card expire on particular date. 3 = Card expiry date is same as Primary Card. Condition: This field is mandatory when Secondary Card Type is '1'(Virtual) and VirtualCardExpOption = 1

Allowable Values:

50

VirtualCardExpAfterTxn

integer

Conditional

Virtual card expiration option after certain number of transaction. Condition: This field is mandatory when Secondary Card Type is '1'(Virtual) and VirtualCardExpOption = 0

VirtualCardExpDate

datetime

Conditional

Virtual card expiration option at exact date. Valid Values: 0-9 Format: MM/DD/YYYY Example: 01/01/2024 Condition: This field is mandatory when Secondary Card Type is '1'(Virtual) and VirtualCardExpOption = 2

VirtualCardExpDuration

string

Conditional

Virtual card expiration duration like hour, minute, day etc Valid Values: 0 = Minutes 1 = Hour 2 = Day 3 = Week 4 = Month 5 = Year Condition: This field is mandatory when Secondary Card Type is '1'(Virtual) and VirtualCardExpOption = 1

Allowable Values:

50

VirtualCardExpDurationValue

integer

Conditional

Virtual card expiration Duration Value. Valid Values:0-9 Format:XXX Example:Virtual Card Expiry duration is 4(month) then this field value can be of 1-12. Condition:This field is mandatory when Secondary Card Type is '1'(Virtual) and VirtualCardExpOption = 1

VirtualCardLimit

decimal

Optional

Card limit of Virtual card. It can be 0 or Null. If it is 0 or Null then card will use Account's Credit Limit. Valid Values: 0-9 Format: XXXX.XX Example: 1000.00

VirtualCardResetAllow

integer

Conditional

Flag to allow or not allow reset on Virtual card. Valid Values:0 = Yes, 1 = No Example:0 Condition: This field is mandatory when Secondary Card Type is '1'(Virtual).

QRCode

string

Optional

This tag is to capture the QR code image file URL. Valid Values: 0-9,a-z Format: https/abc.com Example: https/abc.com

Allowable Values:

100

SignatureID

string

Optional

This tag is to capture the user signature image file in URL. Valid Values: 0-9,a-z Format: https/abc.com Example: https/abc.com

Allowable Values:

100

DeliveryMechanism

string

Optional

Shipment delivery mechanism.By Default Setting must be for standard Delivery and Usually overnight delivery involves card fee in credit environment. Valid Values: 0-Standard 1-Priority 2-Overnight Example:0

Allowable Values:

5

SharedCreditLimit

integer

Optional

This tag defines whether the same credit limit of the Primary borrower will be shared with the Secondary card or a different limit. Valid Values: 0-No,1-Yes Example:1 Condition: If no value sent in this tag, then system should by default consider the value as "Yes". If "Yes" is selected, then Secondary Card holder will have same credit limit as Primary Applicant.

SecondaryCardUsageLimit

decimal

Conditional

The usage limit defined for the secondary card. This limit is shared limit with the Primary Card. Valid Values: 0-9 Example:1000 Condition: If SharedCreditLimit is set as 'No' then this field is mandatory. If amount entered in this field is greater than Primary Borrower’s Credit limit, or less than set amount on the product, then an error message to be triggered.

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,
  "AccountNumber": "700000000785214",
  "AdminNumber": 100989,
  "SecondaryCardType": "0",
  "Title": null,
  "FirstName": "John",
  "MiddleName": "K",
  "LastName": "Peter",
  "SurnameSuffix": null,
  "DateOfBirth": "04/04/1990 00:00:00",
  "AddressLine1": "address1",
  "AddressLine2": null,
  "City": "bhopal",
  "Country": "US",
  "PostalCode": "12345",
  "State": "AL",
  "ShippingAddressFlag": null,
  "HomePhoneNumber": "7684534354",
  "WorkPhoneNumber": null,
  "MobilePhoneNumber": null,
  "MobileCarrier": null,
  "LanguageIndicator": null,
  "EmailID": null,
  "SSN": "147852369",
  "IDNumber": null,
  "MotherMaidenName": null,
  "IDTypeCode": null,
  "IDIssueDate": null,
  "IDExpirationDate": null,
  "IDCountry": null,
  "IDIssueState": null,
  "NameOnCard": null,
  "EmbossingLine4": null,
  "HoldEmbossing": 0,
  "CardImageID": null,
  "NameOnTrack": null,
  "ActivationCode": null,
  "ClientID": null,
  "VirtualCardExpOption": null,
  "VirtualCardExpAfterTxn": null,
  "VirtualCardExpDate": null,
  "VirtualCardExpDuration": null,
  "VirtualCardExpDurationValue": null,
  "VirtualCardLimit": null,
  "VirtualCardResetAllow": null,
  "QRCode": null,
  "SignatureID": null,
  "DeliveryMechanism": null,
  "SharedCreditLimit": null,
  "SecondaryCardUsageLimit": null
}
Response fields detail
Fields Description

CardNumber

string

Card Number of account holder. Valid Values: 0-9 Format:XXXXXXXXXXXXXXXX Example:1236547896325874

Allowable Values:

19

AccountNumber

string

Account number of Card holder under which secondary card created. Valid Values:0-9 Format:XXXXXXXXXXXXXXXX Example:8000000000000037

Allowable Values:

19

AdminNumber

int64

Details can be obtained by admin number (Embossing Acctid). Valid Values:0-9 Format:XXXXX Example:12345

SecondaryCardType

string

Type of secondary card Valid Values: 0 -Regular Secondary Card, 1-Virtual Card Example: 0

Allowable Values:

25

CardStatus

string

Status of the requested card Example: New Card Pending Activation, Cancelled etc

Allowable Values:

25

FirstName

string

Card holder's First name. Example:John

Allowable Values:

40

LastName

string

Card holder's last name. Example:Smith

Allowable Values:

40

NameOnCard

string

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

Allowable Values:

50

PrimaryExpiryDate

datetime

Expiry date of primary card under which secondary card is being created. Valid Values:0-9 Format: MM/DD/YYYY HH:MM:SS Example: 01/01/2020 11:05:05

ValidFrom

datetime

Card Creation Date of requested card. Format:MM/dd/yyyy HH:mm:ss Example:01/01/2020

ValidTo

datetime

Card Expiration Date of requested card. Format:MM/dd/yyyy HH:mm:ss Example:01/01/2022

CVC

string

3 Digit security number printed on back side of the card. Valid Values: 0-9 Format: XXX Example: 456

Allowable Values:

3

CardExpirationDate

datetime

Card Expiration Date of requested card. Valid Values: 0-9 Format: MM/DD/YYYY HH:MM:SS Example: 01/01/2020 11:05:05

CloseDate

datetime

Card close or cancelation Date of requested card. Format: MM/dd/yyyy HH:mm:ss Example: 01/01/2020

CurrentCardBalance

decimal

Available Balance of Card. Valid Values:0-9 Format:XXX.XX Example:2000.00

ActivationRequired

boolean

Flag to identify whether activation is required or not.

CustomerID

string

Unique ID associated with Customer. Valid Values: 0-9 a-z Example:12345

Allowable Values:

25

Sample response body

{
  "application/json": {
    "Message": "Card created successfully.",
    "Status": true,
    "ErrorCode": "ERR01070",
    "ResponseData": {
      "CardNumber": "XXXXXXXXXXXXXXX",
      "AccountNumber": "45444832544444",
      "AdminNumber": 6467487544,
      "SecondaryCardType": "0",
      "CardStatus": "New Card Pending Activation",
      "FirstName": "John",
      "LastName": "Miller",
      "NameOnCard": "John Miller",
      "PrimaryExpiryDate": "11/02/2022 00:00:00",
      "ValidFrom": "11/02/2020 00:00:00",
      "ValidTo": "11/02/2022 00:00:00",
      "CVC": "XXX",
      "CardExpirationDate": "11/02/2020 00:00:00",
      "CloseDate": "11/02/2020 00:00:00",
      "CurrentCardBalance": 1050.0,
      "ActivationRequired": true,
      "CustomerID": null
    }
  }
}

Request Stock

Action: POST

Endpoint: /api/CoreCredit/AccountHolders/RequestStock

POST /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 detail
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

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 Default: en - English

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

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

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

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

Sample response body

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

Decision On Bulk Card Request

Action: POST

Endpoint: /api/CoreCredit/AccountHolders/ApproveOrDeclineBulkCardRequest

POST /api/CoreCredit/AccountHolders/ApproveOrDeclineBulkCardRequest

Use this API to approve or decline a bulk card (inventory card) request created in the CoreCARD system via the bulk card unique ID or Order ID. If a bulk card request is approved, it is forwarded to the embosser vendor for printing. Rejected requests are marked as "VOID" in the CoreCARD system.

Request fields detail
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 Default: en - English

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

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

OrderID

integer

Conditional

Order ID of the Bulk card order Valid Values:0-9 Format:XXXXX Example:12345 Condition:Either of one identifier is mandatory from: OrderID BulkCardUUID

BulkCardUUID

string

Conditional

Unique number Bulk card order Valid Values:0-9 Format:XXXXX Example:12345 Condition:Either of one identifier is mandatory from: OrderID BulkCardUUID

BulkAction

boolean

Mandatory

Action for the bulk request i.e Approve or decline Valid Values:True(Approve) False(Decline) Format:XXXXX Example:True

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,
  "OrderID": 1002,
  "BulkCardUUID": null,
  "BulkAction": null
}
Response fields detail
Fields Description

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 Format:xxx Example:200

Allowable Values:

15

Sample response body

{
  "application/json": {
    "Message": "Card Creation Approved.",
    "Status": true,
    "ErrorCode": "ERR01123",
    "ResponseData": {
      "ResponseID": "64345"
    }
  }
}