Name
Description
Type
Additional information
san

The cardholders account number. Either the SAN (9-10 digits) can be entered here. Please do not use any spaces or hyphens. Example: 123456789

string

Required

String length: inclusive between 9 and 10

title

The cardholder’s title (Mr, Mrs, Miss) If title is not empty, should be Mr Mrs Mr.

string

Matching regular expression pattern: ^(?i)(Mrs|Miss|Mr|Ms|Dr)

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

Required

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

address1

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

string

Required

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

address2

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

string

None.

city

The Cardholder's city of residence.

string

Required

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

state

The cardholder’s province or state of residence.

string

Required

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

countryIso

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

postalCode

Postal Code of the cardholder's address.

string

Required

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

birthCity

The Cardholder's city of birth

string

None.

dateOfBirth

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

date

None.

idType

The code for the type of identification submitted by the cardholder. 1: Identity Card, 2: Passport Number, 3: Driving License, 4: Social Security Number

integer

None.

idValue

The identification number for the selected IDType. It can include spaces and hyphens. This field is only required if an IDType is specified.

string

None.

phone

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}$

accessCode

Secured Access Code sent to the user. Note:Cardholders will receive an activation email with an ACCESS CODE to activate and access their card on Cardportal.com.

string

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.