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

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

Optional

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 Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

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 Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

50

MiddleName

string

Optional

Card holder's Middle Name. Example: LEE Condition: Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

50

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 Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

50

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: 02/01/2020 Condition: Required if the parameter is been set as mandatory on product and card type is 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) Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

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) Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

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) Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

25

Country

string

Conditional

Indicates shipping Country Valid Values: A-B,0-9 Example : USA Condition: Required if the parameter is been set as mandatory on product and card type is regular secondary card. Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

5

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) Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

9

State

string

Conditional

Indicates shipping State. Valid Values:A-B,0-9 Format:XXXXX Example: Virginia Condition: Required if the parameter is been set as mandatory on product and card type is regular secondary card. Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

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:

15

WorkPhoneNumber

string

Optional

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

Allowable Values:

15

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

Cardholder's preferred Language Valid Values: a-z Format: xx Example: English

Allowable Values:

50

EmailID

string

Optional

Card Holder's email Address Format: XXX @xx.com Example:ABC @gmail.com Condition: Required if the parameter is been set as mandatory on product and card type is regular secondary card.

Allowable Values:

256

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 if the parameter is been set as mandatory on product and card type is 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

Type of Government issued identification. Valid Values: Refer Appendix section 5.2 Example: 10 Condition: This field will become mandatory basis following two conditions: 1.For US State Cards This field is mandatory only when ID Type on product is set as Yes for Card Type=Primary. 2.For Non-US State cards This field is mandatory only when ID Type (Non-US) on product is set as Yes for Card Type=Primary.

IDIssueDate

DateTime

Conditional

Issue date of ID card. Valid Values:0-9 Format:MM/DD/YYYY Example:02/01/2020 Condition: Required when ID number is filled.

IDExpirationDate

DateTime

Conditional

Government issued identification expiration date. Valid Values:MM/DD/YYYY Example:02/01/2020 Condition: Required when ID number is filled.

IDCountry

string

Conditional

Issue Country of Identification proof. Valid Values:a-z, 0-9 Example: Canada Condition:Required when ID number is filled.

Allowable Values:

50

IDIssueState

string

Conditional

Issue state of Identification proof Valid Values:a-z, 0-9 Example: AL Condition: Required when ID number is filled.

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 Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

50

EmbossingLine4

string

Optional

Embossing line4- Data goes in embossing file. Valid Values:a-z, 0-9 Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

20

HoldEmbossing

integer

Optional

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

CardImageID

string

Optional

Art/Template ID based on this Card’s Image will be displayed Valid Values:0-9, a-z Format:XXXX Example:30abc

Allowable Values:

50

NameOnTrack

string

Optional

Name on Track echo in embossing file. Valid Values : 0-9,A-Z Example : N Noel Condition: Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

26

ActivationCode

string

Optional

Code which is provided at the time of Account Creation/Registration should be pass as a user validation. Valid Values : 0-9, A-Z Example - 123 Condition: Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

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).

Allowable Values:

50

VirtualCardExpAfterTxn

integer

Conditional

Virtual card expiration option after certain number of transaction. 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 = 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 3-Standard Exp 4-Priority Exp 5-Overnight Exp Example:0 1.Condition:Values 3,4,5 are onlyapplicablefor Perfect PlasticCard Vendor

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.

CardRelationship

integer

Optional

Indicates the Secondary Card relation to the Primary Card. Valid Values: 0- Authorized User (Default Value) and 1-Co-Owner Example:0

ShippingAddressLine1

string

Conditional

Shipping address line 1 Example: 2354 Main road Condition: If ShippingAddressFlag is 1 then it is mandatory Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

50

ShippingAddressLine2

string

Optional

Shipping address line 2 Example:xyz Avenue Condition: Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

50

ShippingCity

string

Conditional

Shipping address city name Example: chicago Condition: If ShippingAddressFlag is 1 then it is mandatory Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

25

ShippingState

string

Conditional

State of the shipping address For Input Values Refer Appendix Section 5.6 for State Name Codes Valid Values: a-z Format:XXX Example:MO Condition: If ShippingAddressFlag is 1 then it is mandatory Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

30

ShippingCountry

string

Conditional

Shipping address Country name For Input Values Refer Appendix Section 5.1 for Country Name Codes Valid Values: a-z Format:XXX Example:US Condition: If ShippingAddressFlag is 1 then it is mandatory Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

5

ShippingPostalCode

string

Conditional

Zip code of the shipping address. Valid Values: 0-9 Example - 46227 Condition: If ShippingAddressFlag is 1 then it is mandatory Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

9

CardLevelUserFieldValue1

string

Optional

Card Level User Field value. Valid Values: A-Z,0-9 Example: Yes

Allowable Values:

9

CardLevelUserFieldValue2

string

Optional

Card Level User Field value. Valid Values: A-Z,0-9 Example: Yes

Allowable Values:

9

CardLevelUserFieldValue3

string

Optional

Card Level User Field value. Valid Values: A-Z,0-9 Example: Yes

Allowable Values:

9

CardLevelUserFieldValue4

string

Optional

Card Level User Field value. Valid Values: A-Z,0-9 Example: Yes

Allowable Values:

9

CardLevelUserFieldValue5

string

Optional

Card Level User Field value. Valid Values: A-Z,0-9 Example: Yes

Allowable Values:

9

CardLevelUserFieldValue6

string

Optional

Card Level User Field value, When Card Level User Field is defined as Drop Down of Text Type then Valid value of Drop Down should be retrieved using GetUserFieldDetails API and then provided in this field. Valid Values: A-Z,0-9 Example: Yes

Allowable Values:

9

CardLevelUserFieldValue7

string

Optional

Card Level User Field value, When Card Level User Field is defined as Drop Down of Text Type then Valid value of Drop Down should be retrieved using GetUserFieldDetails API and then provided in this field. Valid Values: A-Z,0-9 Example: Yes

Allowable Values:

9

CardLevelUserFieldValue8

string

Optional

Card Level User Field value, When Card Level User Field is defined as Drop Down of Text Type then Valid value of Drop Down should be retrieved using GetUserFieldDetails API and then provided in this field. Valid Values: A-Z,0-9 Example: Yes

Allowable Values:

9

CardLevelUserFieldValue9

string

Optional

Card Level User Field value, When Card Level User Field is defined as Drop Down of Text Type then Valid value of Drop Down should be retrieved using GetUserFieldDetails API and then provided in this field. Valid Values: A-Z,0-9 Example: Yes

Allowable Values:

9

CardLevelUserFieldValue10

string

Optional

Card Level User Field value, When Card Level User Field is defined as Drop Down of Text Type then Valid value of Drop Down should be retrieved using GetUserFieldDetails API and then provided in this field. Valid Values: A-Z,0-9 Example: Yes

Allowable Values:

9

UniqueId

string

Optional

Unique ID is a transaction specific unique ID. This ID is unique for every transaction. If multiple calls are made by client for a specific transaction, the value of this tag will always be the same for a specific transaction. (GUID and UUID datatypes are supported for this tag). Valid Values: A-Z, 0-9 Example: F965C56F-C58F-EC11-B80E-A4BF010A357E Condition:For API user, if API Idempotency Applicable is set as Yes on CoreCredit, field is mandatory. The UniqueId is valid for 7 days from first submission of the request. Same request can be retried for 7 days without performing the same action twice.Idempotency will be checked at the belongingOwning Partner and Merchant Level.

Allowable Values:

40

SecondaryCardCashUsageLimit

decimal

Conditional

The Cash usage limit defined for the secondary card. This Cash usage limit is shared 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.

ShareSpendLimitswithPrimary

integer

Optional

This tag defines whether the same Spend limits of the Primary borrower will be shared with the Secondary card or a different spend limit. Valid Values: 0-No,1-Yes Example:1 Condition: If no value sent in this tag, then an error message will be displayed 'Please provide value for Share Spend Limits with Primary' If 'Yes' is selected, then Secondary Card holder will have same spend limit as Primary Applicant.

VirtualCardAutoReset

integer

Conditional

Flag to decide if Virtual Card Limit will get auto-reset or not. Valid Values: 0 = Yes (Virtual Card Limit will be Auto-Reset) 1 = No(Virtual Card Limit will not be Auto-Reset) Format: X Example: 0,1 Condition: Allowed only if- 1. Virtual Card Limit has a value except 0 or NULL. 2. ‘Usage Reset Frequency’ is set to Billing Cycle at Product Level. 3. If no value is passed, then by default null will be considered as no auto-reset applicable.

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