Contains information about the credit card holder
Request
Property Name | Type | Required | Description |
|---|---|---|---|
| string | Optional | Cardholder's address line 1. |
| string | Optional | Cardholder's address line 2. |
| string | Optional | Cardholder's city. |
| string | Optional | The cardholder's company name. Maximum 100 characters. |
| string | Optional | Cardholder's country code. |
| string | Required for local LatAm processing only | Cardholder's email address. |
| string | Optional | Cardholder's first name. Note: On your checkout form, if you collect both first and last name in the same input field (i.e., |
| string | Optional | Cardholder's last name. |
| string | Optional | A merchant's ID for a specific shopper. |
| 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:
|
| string | Optional | Cardholder's phone number. Minimum requirements: 5 numeric characters, with the following exceptions:
Maximum requirements: Combination of 36 alphanumeric characters and the following special characters: Note: American Express recommends that you send the cardholder's phone number to improve authorization rates. |
| string | Optional | Cardholder's state code. |
| string | Optional | Cardholder's ZIP code. |
Response
Property Name | Type | Description |
|---|---|---|
| string | Cardholder's address line 1. |
| string | Cardholder's address line 2. |
| string | Cardholder's city. |
| string | The cardholder's company name. Maximum 100 characters. |
| string | Cardholder's country code. |
| string | Cardholder's email address. |
| string | Cardholder's first name. |
| string | Cardholder's last name. |
| string | A merchant's ID for a specific shopper. |
| string | The shopper's local personal identification number.
|
| string | Cardholder's phone number. |
| string | Cardholder's state code. |
| string | Cardholder's ZIP code. |
