Category links

API Links

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

This tag indicates the Branch code from where the card was issued. Valid Values:0-9 Example:1006 Condition : This tag is mandatory when decision flag is 1

Allowable Values:

25

ProductID

Int32

Conditional

Description : This tag indicates the Product ID. Condition : This tag is mandatory when decision flag is 1. Valid Values:0-9 Example:1511

Allowable Values:

10

ClientID

string

Optional

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

Allowable Values:

50

ShippingMode

string

Optional

Description : Indicates the Method of Shipping E.g.Standard, USPS

Allowable Values:

50

AcctYesNo

string

Mandatory

Describes whether only Account number should be used in the cards that are being created or not. Valid Values : 1 ,2 1= YES 2= NO Condition : This tag is mandatory when decision flag is 1

Allowable Values:

1

Title

string

Optional

Title for the customer can be set by this tag. Valid Values: Refer Appendix section : Title Values Example: 01 = MR 02 = MRS 03 = MISS 04 = MS 05 = DR 06 = PROF 07 = H.H 08 = SHAIKH 09 = H.E 10 = SIR 11 = MADAM

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:

40

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

Description : This tag indicates the name printed on the card

Allowable Values:

26

Addressline1

string

Conditional

Description : This tag indicates the Address Line 1 of the cardholder. Valid values are A-Z, a-z, 0-9 Condition : This tag is mandatory when decision flag is 1

Allowable Values:

50

Addressline2

string

Optional

Description : This tag indicates the Address Line 2 of the cardholder. Valid values are A-Z, a-z, 0-9

Allowable Values:

50

City

string

Conditional

Description : This tag indicates the Cardholder City of residence Valid values are A-Z, a-z, 0-9 Example: Norcross Condition : This tag is mandatory when decision flag is 1

Allowable Values:

25

ZIPCode

string

Conditional

Description: This tag indicates the Postal code of cardholder residence Valid values are A-Z, a-z,0-9 Example:30093 Condition : This tag is mandatory when decision flag is 1

Allowable Values:

10

Country

string

Conditional

Two Character Country Code should be passed in the request. Valid values :A-Z, a-z Example: US Condition : This tag is mandatory when decision flag is 1

Allowable Values:

2

State

string

Conditional

This tag indicates the state of the inventory created. Condition : This tag is mandatory when decision flag is 1 Example: GA Valid values are A-Z, a-z

Allowable Values:

2

UserID

string

Mandatory

Description : This tag indicates the user id of the user who is performing the activity. Valid Values: A-Z,a-z,0-9 Example: ccadmin/portalsuperuser

Allowable Values:

128

FICompanyName

string

Conditional

Indicates the company name Condition : This tag is mandatory when decision flag is 1

Allowable Values:

26

OrderId

decimal

Conditional

Condition: When decision flag = 2,3, 4 then this should become Mandatory Valid values : 0-9 Example : 3478

DecisionFlag

string

Mandatory

DecisionFlag: This tag decides what operation needs to be performed. Valid Values: 1 = When you are creating an inventory 2 = When you are updating an inventory 3 = When you are Approving an inventory 4 = When you are Rejecting an inventory

Allowable Values:

2

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

Card Number of the Card Valid values are 0-9 Clear Card Number Example : *********1234567[For Compliance masked BIN and Extended BIN] Condition :At least one of Account Number/Proxy Number/ Card Number is required.

Allowable Values:

16

AccountNumber

string

Conditional

This tag indicates the Account Number of the cardholder. Valid values: 0-9 Example: 2000000000000396893 Condition: At least one of Account Number/Proxy Number/ Card Number is required.

Allowable Values:

19

ProxyNumber

string

Conditional

This tag indicates the Proxy Number of the cardholder Valid values:0-9 E.g:1005 Condition: At least one of Account Number/Proxy Number/ Card Number is required.

Allowable Values:

19

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

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

Indicates the order ID of the inventories that are created. Valid values : 0-9 Example : 3478

Allowable Values:

19

FetchDetail

string

Mandatory

Description : This tag indicates which cards to be fetched. Condition : 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

The Proxy number from where a transaction shall be initiated Valid values: 0-9 Example: 1001741741741 Note : This will be applicable only when FetchDetail value is 2

Allowable Values:

19

ProxyNumberTo

string

Optional

The Proxy number till where a transaction shall be initiated Valid values: 0-9 Example: 1001741741741 Note : This will be applicable only when FetchDetail value is 2

Allowable Values:

19

PlasticCode

string

Optional

This tag indicates the plastic code. Note : This will be applicable only 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

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

Allowable Values:

19

OrderID

string

Optional

Indicates the order number for an inventory. Exapmple:3745

Allowable Values:

19

ClientID

string

Optional

Indicate Client Id and echo in embossing file Valid Values: 1422245

Allowable Values:

50

ProductID

string

Mandatory

Product ID of the Product under which the account should be created. Valid Values:0-9 Example:1511

Allowable Values:

50

BranchCode

string

Mandatory

This tag indicates the 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

This tag indicates the beginning range of card number. Valid values: 0-9 Example: 4066846120023634

Allowable Values:

16

ToCardNumber

string

Optional

This tag indicates the End range of card number. Valid values: 0-9 Example: 4066846120023634

Allowable Values:

16

ProxyNumberFrom

string

Optional

This tag indicates the beginning range of Proxy Number. Valid values: 0-9 Example: 1001741741741

Allowable Values:

19

ProxyNumberTo

string

Optional

This tag indicates the End range of Proxy Number. Valid values: 0-9 Example: 1001741741741

Allowable Values:

19

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

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

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

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

Indicates the order number for an inventory. Ex: 3745

Allowable Values:

19

DispatchDate

datetime

Mandatory

Description: This tag indicates the Date of when the inventory was dispatched. Format: yyyy-mm-ddThh:mm:ss Example:2017-09-26T00:00:00

InvoiceNumber

string

Optional

Description - Invoice Number for Transaction Valid Values: A-Z 0-9 Format:XXXXXXXXXX Example: AB987567757

ShippingMode

string

Optional

Description : Indicates the Method of Shipping Example.Standard, USPS

Allowable Values:

50

AWBNumber

string

Optional

Indicates the Air Way Bill Number of an inventory transfer Example:156463

Allowable Values:

50

Sample Request Body
{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "OrderID": "190083",
  "DispatchDate": "2022-03-27T14:30:00-04:00",
  "InvoiceNumber": "145654645",
  "ShippingMode": "1",
  "AWBNumber": "1210201901"
}
Response Fields Detail
Fields Description

OrderID

string

Indicates the order number for an inventory. Ex: 3745

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

Optional

Description:Indicates the OrderID of the inventory created. Condition : Either order ID, Account Number or Proxy Number is required. Example:3745

Allowable Values:

19

FromBranchCode

string

Mandatory

This tag indicates the Branch code from where the card will be sent to another branch code Valid Values: A-Z, a-z, 0-9 Example:AC1006

ToBranchCode

string

Mandatory

This tag indicates the Branch code 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

This tag Indicates whether the receipt of the transfer should be generated automatically or not. Conditions: 0 = yes 1 = NO

Allowable Values:

1

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

Indicates the order ID of the inventories that are created. 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

Indicates the order number for an inventory. Example: 3745

Allowable Values:

19

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

Indicates the order ID of the inventories that are created. Valid values: 0-9 Example: 3478

RequestedOn

datetime

Request date time of activity Format: MM/DD/YYYY HH:mm:ss:msi Example: 09/12/2016 15:51:19:000

NumberOfCards

decimal

Indicates the number of cards that were ordered when requesting for an inventory. Valid values: 0-9 Example: 17

OrderStatus

string

This tag indicates the status of the inventory order. Valid values: 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.

BulkShipaddress1

string

This tag indicates the Address Line 1 of the cardholder. Valid values: A-Z, a-z, 0-9

BulkShipaddress2

string

This tag indicates the Address Line 2 of the cardholder. Valid values: A-Z, a-z, 0-9

City

string

This tag indicates the Cardholder City of residence Valid values are A-Z, a-z, 0-9 Example: Norcross

PostalCode

string

This tag indicates the Postal code of cardholder residence Valid values are A-Z, a-z,0-9 Example: 30093

Country

string

This tag indicates the country. Valid values :A-Z, a-z Example: US Refer Appendix section : Country Code Values

State

string

This tag indicates the Cardholder State of residence

FICompanyName

string

This tag is used to display the company name when the cards are to be sent to a specific corporate address

AttnName

string

This tag represents attention name. Can be used to store additional information.

AcctYesNo

string

This tag Indicates whether to display the Cardholder First Name, Middle Name, last name or use only account number Valid values: 0 = No 1 = Yes

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 can be set by this tag. Valid Values: Appendix Section- Refer Appendix 1.4 section Example: Mr. , Mrs, Dr.

FirstName

string

This tag indicates the Cardholder First Name. Valid values: A-Z, a-z Example: Andrew

MiddleName

string

This tag indicates the cardholder Middle Name Valid values: A-Z, a-z, 0-9 Example: Charles

LastName

string

This tag indicates the Cardholder Last Name Valid values: A-Z, a-z Example: Hudson

NameOnCard

string

This tag indicates the Name on Card Example: John R David

RequestedBy

string

Indicates the details of the person who had requested the inventory. Example: abcd.admin

ProductName

string

Reflects the name of product for the account Valid Values: a-z Format: xxxxxx Example: abcsolutionsrevolving

ApprovedBy

string

Indicates the details of the person who has approved the inventory order. Example: abcd.admin

ApprovedOn

datetime

Indicates the date on which the inventory order were approved Example: 01/01/2020

SourceLocation

string

This tag indicates the source location of the inventory

DestinationLocation

string

This tag indicates the destination

AWBNumber

string

Indicates the Air Way Bill Number of an inventory transfer Example: 156463

DispatchDate

datetime

This tag indicates the Date of when the inventory was dispatched. Format: yyyy-mm-ddThh:mm:ss Example:2017-09-26T00:00:00

InvoiceNumber

string

Description - Invoice Number for Transaction Valid Values: A-Z 0-9 Format:XXXXXXXXXX Example: AB987567757

BranchCode

string

Indicates the Branch Code of the branch Valid values: A-Z,0-9 Example: C0001

EmbossingLine4

string

This tag indicates the name printed on the card

ClientName

string

This tag indicates the name of the client.

BranchStoreName

string

This tag indicates the Store Name of the branch.

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

Indicates the order number for an inventory. Example: 3745

Allowable Values:

19

ClientID

string

Optional

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

Allowable Values:

50

InventoryStatus

string

Optional

Description : Indicates the 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

Product ID of the Product under which the account should be created. Valid Values: 0-9 Example: 1511

Allowable Values:

10

PlasticCode

string

Optional

Plastic Code Valid values:0-9 Example: 32

Allowable Values:

100

BranchCode

string

Optional

This tag indicates the Branch code from where the card was issued. Valid Values: A-Z, a-z, 0-9 , Example:DC1006

Allowable Values:

20

AccountNumber

string

Optional

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

Allowable Values:

19

ProxyNumber

string

Optional

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

Allowable Values:

19

OrderRequestDate

string

Optional

Description : This tag Indicates the Date of when the order was requested. Format:mm/dd/yyyy Example:09/26/2020

Allowable Values:

10

CreateDate

string

Optional

Description : This tag indicates the date of when was the order created Format: mm/dd/yyyy Example:12/26/2020

Allowable Values:

10

NumberOfCard

string

Optional

Description : This tag indicates the list of cards to be fetched as per last request.

Allowable Values:

10

CardNumber

string

Optional

This tag indicates the Card Number of the cardholder Valid values:0-9 Clear Card Number. Example: *********4567[For Compliance masked BIN and Extended BIN].

Allowable Values:

16

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

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

Indicates the order number for an inventory. Example: 3745

Allowable Values:

19

ProxyNumber

string

Optional

This tag indicates the Proxy Number of the cardholder Valid Values: 0-9 Example: 1005

Allowable Values:

19

AccountNumber

string

Optional

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

Allowable Values:

19

ReceiptStatus

string

Mandatory

Indicates the receipt Status. Valid values are : 1 = Transfer Received 2 = Transfer - Lost in Transit 3 = Transfer - Damaged in Transit 4 = Received 5 = Lost in Transit 6 = Damaged in Transit

Allowable Values:

50

ReceiptStatusDate

datetime

Mandatory

Date on which inventory marked received or lost in transit Example: 07/23/2020 (MM/DD/YYYY)

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": {}
}