APIVersion

string

Mandatory

Version of the API to be invoked Example: 1.3

Allowable Values:

10

IPAddress

string

Mandatory

IP Address of sender Example: 10.206.0.204

Allowable Values:

15

Source

string

Mandatory

Source from where API Call is initiated. CoreCard have multiple value of source for internal system (CoreMoney, SelfService, IVR, MobileSelfService) For external system expected source will be WEB.

Allowable Values:

50

CallerID

string

Optional

Caller Id of source from where API is initiated. It is End User phone number. Example: 7204454214 Condition - applicable in Case of IVR

Allowable Values:

20

CalledID

string

Optional

Called Id of destination for which API is initiated. It is Corecard IVR number. Example: 7314145404 Condition - applicable in Case of IVR

Allowable Values:

20

SessionID

string

Optional

Reserved for future use

Allowable Values:

50

ANI

string

Optional

Reserved for future use

Allowable Values:

0

DNS

string

Optional

Reserved for future use

Allowable Values:

0

Language

string

Optional

Flag to retrieve error message in specific language Example: 'en' for English

Allowable Values:

2

RequestDate

string

Optional

Request Date Time of API Format: MM-DD-YYYYTHH:MM:SS Example:- 11-12-2021T13:05:10

Allowable Values:

19

BranchCode

string

Mandatory

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

Allowable Values:

20

ProductID

Int32

Conditional

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

Allowable Values:

10

ClientID

string

Optional

Client Id Valid Values: 1422245 Format:XXXXX

Allowable Values:

50

ShippingMode

string

Optional

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

Allowable Values:

50

AcctYesNo

string

Mandatory

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

Allowable Values:

1

Title

string

Optional

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

Allowable Values:

9

FirstName

string

Optional

Cardholder First Name Valid Values: A-Z, a-z and all special characters Example: Andrew

Allowable Values:

50

MiddleName

string

Optional

Cardholder Middle Name Valid Values: A-Z, a-z and all special characters Example: Charles

Allowable Values:

50

LastName

string

Optional

Cardholder Last Name Valid Values: A-Z, a-z and all special characters Example: Hudson

Allowable Values:

50

NameOnCard

string

Optional

Name to be Embossed on Card Valid Values: A-Z, a-z and all special characters Example: Hudson M Charles

Allowable Values:

28

EmbossingLine4

string

Optional

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

Allowable Values:

26

Addressline1

string

Conditional

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

Allowable Values:

50

Addressline2

string

Optional

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

Allowable Values:

50

City

string

Conditional

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

Allowable Values:

25

ZIPCode

string

Conditional

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

Allowable Values:

10

Country

string

Conditional

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

Allowable Values:

2

State

string

Conditional

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

Allowable Values:

3

UserID

string

Mandatory

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

Allowable Values:

128

FICompanyName

string

Conditional

Company name Condition : Mandatory when decision flag is 1

Allowable Values:

26

OrderId

decimal

Conditional

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

DecisionFlag

string

Mandatory

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

Allowable Values:

2

PlasticDetailsType

array

Optional

PlasticCode

string

Conditional

Plastic Code Valid values:0-9 Example: 32 Condition "Mandatory when decision flag is 1. Optional when decision flag is 2".

Allowable Values:

100

LogoID

string

Optional

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

Allowable Values:

10

NumberOfCards

Int32

Conditional

Total number of cards. Valid values: 0-9 Example: 17 Condition : Mandatory when decision flag is 1 Note : Maximum allowed limit is 5000 , can be decreased by program manager

Message

string

Returns Error Message in case of Error.

Status

boolean

Returns result of API processing. If any error is found then value will be 'false' else 'true'.

ErrorCode

string

Returns Error Code in case of Error.

ResponseData

This is group of below data elements.

OrderID

decimal

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

RequestIDList

array

RequestID

decimal

Unique Id of the cards which are created from Inventory Valid values : 0-9 Example : 3478