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

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

deliveryCity

The Cardholder's city 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

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})?

notify

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

boolean

None.

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.

emailSubjectLine

Non-mandatory field for the subject of the email being sent to the receiver of the gift card.

string

None.

gifter

The name of the person who sends the gift card, sits here

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.