QRCode

string

Optional

This tag is to to capture the QR Code image file URL. Valid Values: a-z,0-9 Format: url format Example: https://test/qr/d969e78921

Allowable Values:

50

SignatureID

string

Optional

This tag is to to capture the user signature image file URL. Valid Values: a-z,0-9 Format:url format Example: https://test/qr/d969e78921

Allowable Values:

50

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

AdminNumber

int64

Conditional

Details can be obtained by admin number (Embossing Acctid) Valid Values:0-9 Format:XXXXX Example:12345 Condition:At least one account identifier is required.

Reason

integer

Optional

Reason to identify why we are requesting card replacement. Possible Values: 1- Stolen 2- Lost 3- Damaged(Status will be marked Closed) 9- ReIssue 10- Breach 11- Other 13- Physical Card 14- Virtual Card Replacement 15- Generate New Card Valid Values:0-9 Format:XX Example:1,9

DecisionFlag

integer

Mandatory

Flag to decide if new card need to be generated with different card number or new plastic with same embossing information. 1- New card with different card number 0- New card with same embossing information. Valid Values: 0,1 Format:X Example:1,0

DeliveryMechanism

string

Conditional

Shipment delivery mechanism. By Default Setting must be for standard Delivery and Usually overnight delivery involves card fee in credit environment. (2-Overnight, 1-Priority , 0-Standard) Valid Values: 0,1,2 Format:xxxx Example:0,1,2 3-Standard Exp 4-Priority Exp 5-Overnight Exp Condition:Values 3,4,5 are only applicable for Perfect Plastic Card Vendor

Allowable Values:

9

CardFee

integer

Conditional

Fee on Card Shipment. If the value is 1 then fees will be charged and if this is 0 then fees will not be charged. Valid Values: 0-1 Format:xxxx Example:0,1 Condition:Delivery Mechanism = 2(Overnight) then fees will always be charged

InstantPersonalize

string

Optional

This flag decides if we want to generate a new card or if want to personalize a card from stack. Valid Values: 0,1 Format:xxxx Example:0,1 Condition: Should be 1 when Decision Flag is 1

Allowable Values:

1

ShippingAddressFlag

integer

Optional

This flag decides if we want to ship the new card to existing address or alternate address. Valid Values: 0 = Ship to Existing Address 1 = Ship Address 2 = Primary Shipping Address Format:X Example:2 Condition:Default value would be 2

ShippingAddressCompanyName

string

Conditional

Indicates Company Name for alternate address which need to be added. Valid Values: 0-9,A-z Format:xxxx Example: XYZ Ltd Condition:This is mandatory only when HoldEmbossing tag value is 0(NO) and ShippingAddressFlag as 1 Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

50

ShippingAddressContactName

string

Conditional

Indicates shipping Contact Name for alternate address which need to be added, Valid Values: 0-9,A-z Format:xxxx Example:XYZ Condition: This is mandatory only when HoldEmbossing tag value is 0(NO) and ShippingAddressFlag as 1.

Allowable Values:

50

AdditionalAddressLine1

string

Conditional

Indicates shipping AddressLine1 for alternate address which need to be added. Valid Values: 0 - 9, a-z Format: XXXXX Example: XYZ Condition:This is mandatory only when HoldEmbossing tag value is 0(NO) and ShippingAddressFlag as 1. Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

50

AdditionalAddressLine2

string

Conditional

Indicates shipping AddressLine2 for alternate address which need to be added. Valid Values: 0 - 9, a-z Format: XXXXX Example: XYZ Condition:This is mandatory only when HoldEmbossing tag value is 0(NO) and ShippingAddressFlag as 1 or Country selected as Non-US. Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

50

AdditionalAddressCity

string

Conditional

Indicates shipping Address City for alternate address which need to be added. Valid Values: 0-9 a-z Format:xxxx Example:kansas Condition:This is mandatory only when HoldEmbossing tag value is 0(NO) and ShippingAddressFlag as 1 or Country selected as Non-US. Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

25

AdditionalAddressCountry

string

Conditional

Indicates shipping Address Country for alternate address which need to be added. Valid Values:0-9 a-z Format:xxxx Example:USA Condition:This is mandatory only when HoldEmbossing tag value is 0(NO) and ShippingAddressFlag as 1 Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

20

AdditionalAddressState

string

Conditional

Indicates shipping Address State for alternate address which need to be added Valid Values: 0-9 a-z Format: xxxx Example: Indiana Condition:This is mandatory only when HoldEmbossing tag value is 0(NO),ShippingAddressFlag as 1 or Country selected as Non-US. Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

30

AdditionalAddressPostalCode

string

Conditional

Indicates shipping Address PostalCode for alternate address which need to be added. Valid Values:0-9 Format:xxxx Example:123456 Condition:This is mandatory only when HoldEmbossing tag value is 0(NO),ShippingAddressFlag as 1 or Country selected as Non-US. Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

9

CardImageID

string

Optional

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

Allowable Values:

100

NameOnCard

string

Optional

Name to be printed on the card. Valid Values:A-Z, 0-9 Format:XXXX Example:John J Condition: Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

50

NameOnTrack

string

Optional

Details to be provided in the Magnetic Strip (mostly derived from Last Name and First name of the Card Holder). Valid Values:a-z Format:XXXX Example:John J Condition: Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

26

ActivationCode

string

Optional

At the time of Account creation/Registration user provide activation code, Present in Account Parameter accordion which is saved in EmbossingAccounts table. Valid Values: A-Z 0-9 Example: AB12345 Condition: This shall be a mandatory tag, if Card Activation Parameter on product is set as 'Activation Code'. Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

50

HoldEmbossing

integer

Optional

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

FirstName

string

Optional

Card holder's First name. Valid Values:A-Z Format:XXXXX Example:User1 Condition: Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

50

LastName

string

Optional

Card holder's last name. Valid Values:A-Z Format:XXXXX Example:Smith Condition: 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 Valid Values: A-Z Format:XXX Example: LEE Condition: Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

50

ReplacementOriginalCardStatus

integer

Optional

Indicates the Status of the original card when request of card replacemnet is made. Possible values are : 1 = Close Existing Card Immediately 3 = Close Existing When New Card Is Activated Default value is 3- Close Existing When New Card Is Activated Valid Values: 1,3 Format: X Example: 1,3

ReplacementOriginalCardAction

integer

Optional

Indicates the Replacement Original Card Action Possible values are 1 = Cancel 2 = Closed Default value is 1(Cancel) Valid Values: 1,2 Format: X Example: 1,2

QRCode

string

Optional

This tag is to to capture the QR Code image file URL. Valid Values: a-z,0-9 Format: url format Example: https://test/qr/d969e78921

Allowable Values:

50

SignatureID

string

Optional

This tag is to to capture the user signature image file URL. Valid Values: a-z,0-9 Format:url format Example: https://test/qr/d969e78921

Allowable Values:

50

IdentifierToken

string

Conditional

A generated token that is not expired can be used as an input field to access API. If we are passing this field in input, user should not pass any other account identifier. Condition:At least one account identifier is required.

Allowable Values:

800

MaskCardNumber

string

Masked number of the newly generated card. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404

Allowable Values:

19

AdminNumber

int64

Admin Number of the newly generated card and this field will populated only when request creating new embossing. Valid Values:0-9 Format:XXXXX Example:12345

CardExpirationDate

string

Card Expiration Date of requested card Valid Values: 0-9 Format: MMYY Example: 0119

CVV

string

This tag refer the CVV of the card Valid Values:0-9 Format:XXX Example:123

Allowable Values:

3

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:

20

ManualCardStatus

string

Card Status when request creating new embossing Valid Values:0-9 Format:XXXXX Example:12345

Allowable Values:

50

OriginalAdminNumber

int64

Admin number of the original old card. Valid Values:0-9 Format:XXXXX Example:12345

OldCardManualStatus

string

Manual status of the old card. Valid Values: 0-9,a-z Format:XXXXX Example:Active,pending

Allowable Values:

50

MaskCardNumber

string

Masked number of the newly generated card. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404

Allowable Values:

19

AdminNumber

int64

Admin Number of the newly generated card and this field will populated only when request creating new embossing. Valid Values:0-9 Format:XXXXX Example:12345

CardExpirationDate

string

Card Expiration Date of requested card Valid Values: 0-9 Format: MMYY Example: 0119

CVV

string

This tag refer the CVV of the card Valid Values:0-9 Format:XXX Example:123

Allowable Values:

3

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:

20

CardStatus

string

status of the new card Valid Values:0-9,a-z Format:XXXXX Example:Active,pending

Allowable Values:

50

OriginalAdminNumber

int64

Admin number of the original old card. Valid Values:0-9 Format:XXXXX Example:12345

OldCardStatus

string

status of the old card Valid Values: 0-9,a-z Format:XXXXX Example:Active,pending

Allowable Values:

50