Contains information about the credit card holder
Request
Property Name | Type | Required | Description |
---|---|---|---|
address | string | Optional | Cardholder's address line 1. Maximum 100 characters. |
address2 | string | Optional | Cardholder's address line 2. Maximum 100 characters. |
city | string | Optional | Cardholder's city. Maximum 42 characters. |
companyName | string | Optional | The cardholder's company name. Maximum 100 characters. |
country | string | Optional | Cardholder's country code. Refer to Country codes |
email | string | Required for local LatAm processing only | Cardholder's email address. Maximum 100 characters. |
firstName | string | Optional | Cardholder's first name. Maximum 100 characters. Note: On your checkout form, if you collect both first and last name in the same input field (i.e., Name field), you can split the input value on the space (" ") character to separate it. |
lastName | string | Optional | Cardholder's last name. Maximum 100 characters. |
merchantShopperId | string | Optional | A merchant's ID for a specific shopper. Maximum 50 characters. |
personalIdentificationNumber | string | Required for local LatAm processing in Brazil; Optional for all other Latam countries. | The shopper's local personal identification number. These are the ID types per country: Argentina: DNI (length 7–11 chars) Brazil: CPF/CNPJ (length 11–14 chars) Chile: RUN (length 8–9 chars) Mexico: CURP/RFC (length 10–18 chars) |
phone | string | Optional | Cardholder's phone number. Minimum Characters: - USA: 10 characters - Denmark, Greenland, Iceland: 8 characters - Other countries: 5 characters.Maximum Characters: 36 charactersAccepts numbers, letters, and these characters: + . * # / \ ( ) –“ |
state | string | Optional | Cardholder's state code. Refer to State and province codes. Supports US and Canada states only. For states in other countries, it is necessary to include the state within the address property. |
zip | string | Optional | Cardholder's ZIP code. Maximum 20 characters. |
Response
Property Name | Type | Description |
---|---|---|
address | string | Cardholder's address line 1. Maximum 100 characters. |
address2 | string | Cardholder's address line 2. Maximum 100 characters. |
city | string | Cardholder's city. Maximum 42 characters. |
companyName | string | The cardholder's company name. Maximum 100 characters. |
country | string | Cardholder's country code. Refer to Country codes |
email | string | Cardholder's email address. Maximum 100 characters. |
firstName | string | Cardholder's first name. Maximum 100 characters. |
lastName | string | Cardholder's last name. Maximum 100 characters. |
merchantShopperId | string | A merchant's ID for a specific shopper. Maximum 50 characters. |
personalIdentificationNumber | string | The shopper's local personal identification number. These are the ID types per country: Argentina: DNI (length 7–11 chars) Brazil: CPF/CNPJ (length 11–14 chars) Chile: RUN (length 8–9 chars) Mexico: CURP/RFC (length 10–18 chars) |
phone | string | Cardholder's phone number. Maximum 36 characters. |
state | string | Cardholder's state code. Refer to State and province codes |
zip | string | Cardholder's ZIP code. |