The cardholder’s title (Mr, Mrs, Miss) If title is not empty, should be Mr Mrs Mr.
None.
The Cardholder's First Name. Note: Firstname and Lastname may only contain a maximum of 20 characters COMBINED.
Required
Matching regular expression pattern: ^[a-zA-Z\s]+$
The Cardholder's Last Name. Note:Firstname and Lastname may only contain a maximum of 20 characters COMBINED.
Required
Matching regular expression pattern: ^[a-zA-Z\s]+$
The Cardholder's Email. Cardholders will receive an activation email with an ACCESS CODE to activate and access their card on Cardportal.com.
Required
The cardholder’s street number, address, and suite or apartment number.
Required
Matching regular expression pattern: ^[a-zA-Z0-9_\s\-\'\.\,\#\/]+$
The cardholder’s address, such as a postal box number, suite #, buzz #. This information is optional.
None.
The Cardholder's city of residence.
Required
Matching regular expression pattern: ^[a-zA-Z\s]+$
The cardholder’s province or state of residence.
Required
Matching regular expression pattern: ^[a-zA-Z\s]+$
A three-digit number(ISO) that identifies the cardholder’s country of residence. (ex. 826 for UK)
Required
String length: inclusive between 3 and 3
Postal Code or Zip Code of the cardholder's address.
None.
The cardholder’s date of birth. (Format: YYYY-MM-DD)
None.
The Cardholder's city of birth
None.
The code for the type of identification submitted by the cardholder. 1: Identity Card, 2: Passport Number, 3: Driving License, 4: Social Security Number
None.
The identification number for the selected IDType. It can include spaces and hyphens. This field is only required if an IDType is specified.
None.
The Cardholder's Mobile
Matching regular expression pattern: ^[\+]?[(]?[0-9]{0,3}[)]?[-\s\.]?[(]?[0-9]{3}[)]?[-\s\.]?[0-9]{3}[-\s\.]?[0-9]{4,6}$
The amount to load on the card. Do not include commas or spaces.
Required
Matching regular expression pattern: [\d]{0,4}([.,][\d]{1,2})?
Card's Currency to be issued in (USD, EUR, GBP,...)
Required
String length: inclusive between 3 and 3
Reference Id From client which gets echoed back in response. ID provided by the Merchant.
None.
Defines if the card should be embossed or gets issued with no name on it. Default is True
None.
The Name that will be embossed under Cardholder name on the card. 4th emboss line is used for Currency and extra possible info such as company's name etc.
String length: inclusive between 0 and 17
Defines if the cardholder should get notified via email=0, SMS=1, SMS and Email both=2, None=3 Default is 0
None.
Define the deliver type (Standard = 0, Registered = 1, Courier = 2) Default is 0 (Standard)
Range: inclusive between 0 and 2
Recipient Name used for those cards which are being sent as courier (Not Standard mail).
Matching regular expression pattern: ^[a-zA-Z\s]+$
Recipient Mobile used for those cards which are being sent as courier (Not Standard mail).
None.
Card type. Plastic = 0, Virtual = 1, ConvertToPlasticRequested = 2, Wallet = 3, MVC = 4
Required
Range: inclusive between 0 and 4
True, if the shipping address is different from cardholder's address, false otherwise
None.
True, if should create the image of the card, false otherwise
None.
Delivery bulk code. Cards with the same bulk code will be delivered together to the same address.
None.
Activate the card or not. Default is false.
None.
True to send the email with create card notification, false in otherwise.
None.
Delivery Address 1. If isDifferentShippingAddress is set as true, this field is mandatory
Matching regular expression pattern: ^[a-zA-Z0-9_\s\-\'\.\,\#\/]+$
Delivery Address 2 If isDifferentShippingAddress is set as true, this field is mandatory
Matching regular expression pattern: ^[a-zA-Z0-9_\s\-\'\.\,\#\/]+$
Delivery Address 3 If isDifferentShippingAddress is set as true, this field is mandatory
Matching regular expression pattern: ^[a-zA-Z0-9_\s\-\'\.\,\#\/]+$
Delivery City If isDifferentShippingAddress is set as true, this field is mandatory
None.
Delivery County/State If isDifferentShippingAddress is set as true, this field is mandatory
None.
Delivery Country ISO Code (ex. 826 for UK) If isDifferentShippingAddress is set as true, this field is mandatory
None.
Delivery Post Code If isDifferentShippingAddress is set as true, this field is mandatory
None.
The merchant group’s username. Provided by your account manager.
Required
The merchant group’s password. Provided by your account manager.
Required
The merchant service index. Provided by your account manager.
Required
A unique number (integer) with which the service is consumed. (This number is unique, random and cannot be reused) This number is unique by each service consumed
Required
Range: inclusive between 1 and 2147483647
Partner's assigned Id number. Provided by your account manager.
Required
Range: inclusive between 1 and 2147483647
Provided by your account manager.
Required
None.