Name
Description
Type
Additional information
firstName

The Cardholder's First Name. Note:Firstname and Lastname may only contain a maximum of 20 characters COMBINED.

string

Required

Matching regular expression pattern: ^[a-zA-Z\s]+$

lastName

The Cardholder's Last Name. Note:Firstname and Lastname may only contain a maximum of 20 characters COMBINED.

string

Matching regular expression pattern: ^[a-zA-Z\s]+$

email

The Cardholder's Email. Cardholders will receive an activation email with an ACCESS CODE to activate and access their card on Cardportal.com.

string

Required

deliveryAddress1

The cardholder’s street number, address, and suite or apartment number.

string

Required

Matching regular expression pattern: ^[a-zA-Z0-9_\s\-\'\.\,\#\/]+$

deliveryAddress2

The cardholder’s address, such as a postal box number, suite #, buzz #. This information is optional.

string

None.

deliveryAddress3

The cardholder’s address, aditional information (is optional)

string

None.

deliveryCity

The Cardholder's city of residence.

string

Required

Matching regular expression pattern: ^[a-zA-Z\s]+$

deliveryState

The cardholder’s province or state of residence.

string

Required

Matching regular expression pattern: ^[a-zA-Z\s]+$

deliveryCountryIso

A three-digit number(ISO) that identifies the cardholder’s country of residence. (ex. 826 for UK)

string

Required

String length: inclusive between 1 and 3

deliveryPostalCode

Postal Code of the cardholder's address.

string

Required

Matching regular expression pattern: ^[A-Z0-9][A-Z0-9\- ]{0,10}[A-Z0-9]$

deliveryCode

The delivery code for the card: If specified, all cards with the same delivery code are to be sent together to the specified delivery address.

string

None.

dateOfBirth

The cardholder’s date of birth. (Format: YYYY-MM-DD)

date

None.

mobile

The Cardholder's Mobile

string

Matching regular expression pattern: ^[\+]?[(]?[0-9]{0,3}[)]?[-\s\.]?[(]?[0-9]{3}[)]?[-\s\.]?[0-9]{3}[-\s\.]?[0-9]{4,6}$

amount

The amount to load on the card. Do not include commas or spaces.

decimal number

Required

Matching regular expression pattern: [\d]{0,4}([.,][\d]{1,2})?

carrierType

The Carrier Product design reference as used by the Card Manufacturer. Identifies the Carrier Product type of the Card Manufacturer.

string

None.

notify

True to send the email with create card notification, false in otherwise.

boolean

None.

isVirtualGiftCard

True, if is a Virtual Gift Card, false otherwise

boolean

None.

userName

The merchant group’s username. Provided by your account manager.

string

Required

password

The merchant group’s password. Provided by your account manager.

string

Required

serviceIndex

The merchant service index. Provided by your account manager.

string

Required

uniqId

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

integer

Required

Range: inclusive between 1 and 2147483647

clientId

Partner's assigned Id number. Provided by your account manager.

integer

Required

Range: inclusive between 1 and 2147483647

transactionToken

Provided by your account manager.

string

Required

orginalPartnerId

integer

None.