{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","results":{"codes":[]},"settings":"","params":[]},"next":{"description":"","pages":[]},"title":"cardHolderInfo","type":"basic","slug":"card-holder-info","excerpt":"Contains information about the credit card holder","body":"###Request\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Required\",\n    \"0-0\": \"`firstName`\",\n    \"0-1\": \"*string*\",\n    \"h-3\": \"Description\",\n    \"0-3\": \"Cardholder's first name.\\nMaximum 100 characters.\\n\\n**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.\",\n    \"2-0\": \"`email`\",\n    \"2-2\": \"**Required** for [local LatAm processing](/docs/latam-local-processing) **only**\",\n    \"2-3\": \"Cardholder's email address.\\nMaximum 100 characters.\",\n    \"2-1\": \"*string*\",\n    \"1-0\": \"`lastName`\",\n    \"1-1\": \"*string*\",\n    \"1-3\": \"Cardholder's last name.\\nMaximum 100 characters.\",\n    \"2-4\": \"A container of card-transaction properties.\\nThis property may appear more than once within the given resource.\",\n    \"h-4\": \"Description\",\n    \"0-2\": \"**Required**\",\n    \"1-2\": \"**Required**\",\n    \"3-0\": \"`country`\",\n    \"3-1\": \"*string*\",\n    \"4-0\": \"`state`\",\n    \"5-0\": \"`address`\",\n    \"4-3\": \"Cardholder's state code.\\nRefer to [State and province codes](/docs/state-and-province-codes).\\nSupports US and Canada states only. For states in other countries, it is necessary to include the state within the `address` property.\",\n    \"4-1\": \"*string*\",\n    \"7-0\": \"`city`\",\n    \"5-1\": \"*string*\",\n    \"8-0\": \"`zip`\",\n    \"7-1\": \"*string*\",\n    \"8-1\": \"*string*\",\n    \"9-0\": \"`phone`\",\n    \"5-3\": \"Cardholder's address line 1.\\nMaximum 100 characters.\",\n    \"3-3\": \"Cardholder's country code.\\nRefer to [Country codes](/docs/country-codes)\",\n    \"3-2\": \"Optional\",\n    \"4-2\": \"Optional\",\n    \"5-2\": \"Optional\",\n    \"7-2\": \"Optional\",\n    \"8-2\": \"Optional\",\n    \"9-2\": \"Optional\",\n    \"9-3\": \"Cardholder's phone number.\\nMaximum 36 characters.\\nAccepts numbers, letters, and these characters: `+ . * # / \\\\ ( ) –“ `\",\n    \"7-3\": \"Cardholder's city.\\nMaximum 42 characters.\",\n    \"8-3\": \"Cardholder's ZIP code.\\nMaximum 20 characters.\",\n    \"9-1\": \"*string*\",\n    \"6-0\": \"`address2`\",\n    \"6-3\": \"Cardholder's address line 2.\\nMaximum 100 characters.\",\n    \"6-2\": \"Optional\",\n    \"6-1\": \"*string*\",\n    \"11-0\": \"`personalIdentificationNumber`\",\n    \"11-1\": \"*string*\",\n    \"11-2\": \"**Required** for [local LatAm processing](/docs/latam-local-processing) in Brazil; Optional for all other Latam countries.\",\n    \"11-3\": \"The shopper's local personal identification number. These are the ID types per country:\\n\\n  * Argentina:  DNI (length 7–11 chars)\\n  * Brazil: CPF/CNPJ (length 11–14 chars)\\n  * Chile: RUN (length 8–9 chars)\\n  * Mexico: CURP/RFC (length 10–18 chars)\",\n    \"10-0\": \"`merchantShopperId`\",\n    \"10-1\": \"*string*\",\n    \"10-2\": \"Optional\",\n    \"10-3\": \"A merchant's ID for a specific shopper.\\nMaximum 50 characters.\"\n  },\n  \"cols\": 4,\n  \"rows\": 12\n}\n[/block]\n###Response\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`firstName`\",\n    \"0-1\": \"*string*\",\n    \"h-3\": \"Description\",\n    \"0-3\": \"Cardholder's first name.\",\n    \"2-0\": \"`email`\",\n    \"2-2\": \"Cardholder's email address.\\nMaximum 100 characters.\",\n    \"2-3\": \"Cardholder's email address.\",\n    \"2-1\": \"*string*\",\n    \"1-0\": \"`lastName`\",\n    \"1-1\": \"*string*\",\n    \"1-3\": \"Cardholder's last name.\",\n    \"2-4\": \"A container of card-transaction properties.\\nThis property may appear more than once within the given resource.\",\n    \"h-4\": \"Description\",\n    \"0-2\": \"Cardholder's first name.\\nMaximum 100 characters.\",\n    \"1-2\": \"Cardholder's last name.\\nMaximum 100 characters.\",\n    \"3-0\": \"`country`\",\n    \"3-1\": \"*string*\",\n    \"4-0\": \"`state`\",\n    \"5-0\": \"`address`\",\n    \"4-3\": \"Cardholder's state code.\\n\\nADD LINK TO LIST OF STATE CODES\",\n    \"4-1\": \"*string*\",\n    \"7-0\": \"`city`\",\n    \"5-1\": \"*string*\",\n    \"8-0\": \"`zip`\",\n    \"7-1\": \"*string*\",\n    \"8-1\": \"*string*\",\n    \"9-0\": \"`phone`\",\n    \"5-3\": \"Cardholder's address.\",\n    \"3-3\": \"Cardholder's country code.\\n\\nADD LINK TO LIST OF COUNTRY CODES\",\n    \"3-2\": \"Cardholder's country code.\\nRefer to [Country codes](/docs/country-codes)\",\n    \"4-2\": \"Cardholder's state code.\\nRefer to [State and province codes](/docs/state-and-province-codes)\",\n    \"5-2\": \"Cardholder's address line 1.\\nMaximum 100 characters.\",\n    \"7-2\": \"Cardholder's city.\\nMaximum 42 characters.\",\n    \"8-2\": \"Cardholder's ZIP code.\",\n    \"9-2\": \"Cardholder's phone number.\\nMaximum 36 characters.\",\n    \"9-3\": \"Cardholder's phone number.\",\n    \"7-3\": \"Cardholder's city.\",\n    \"8-3\": \"Cardholder's ZIP code.\",\n    \"9-1\": \"*string*\",\n    \"6-0\": \"`address2`\",\n    \"6-1\": \"*string*\",\n    \"6-2\": \"Cardholder's address line 2.\\nMaximum 100 characters.\",\n    \"11-2\": \"The shopper's local personal identification number. \\nThese are the ID types per country:\\n\\n  * Argentina:  DNI (length 7–11 chars)\\n  * Brazil: CPF/CNPJ (length 11–14 chars)\\n  * Chile: RUN (length 8–9 chars)\\n  * Mexico: CURP/RFC (length 10–18 chars)\",\n    \"11-1\": \"*string*\",\n    \"11-0\": \"`personalIdentificationNumber`\",\n    \"10-0\": \"`merchantShopperId`\",\n    \"10-1\": \"*string*\",\n    \"10-2\": \"A merchant's ID for a specific shopper.\\nMaximum 50 characters.\"\n  },\n  \"cols\": 3,\n  \"rows\": 12\n}\n[/block]","updates":[],"order":3,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5e5d3aa2dc4d35003d784d27","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"JSON Objects","slug":"resources","order":13,"from_sync":false,"reference":false,"_id":"5e5d3aa2dc4d35003d784cfb","version":"5e5d3aa2dc4d35003d784d9d","project":"57336fd5a6a9c40e00e13a0b","createdAt":"2015-10-15T16:20:51.519Z","__v":0},"parentDoc":null,"project":"57336fd5a6a9c40e00e13a0b","user":"560d5913af97231900938124","version":{"version":"8976-JSON","version_clean":"8976.0.0-JSON","codename":"Live","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5e5d3aa2dc4d35003d784cf0","5e5d3aa2dc4d35003d784cf1","5e5d3aa2dc4d35003d784cf2","5e5d3aa2dc4d35003d784cf3","5e5d3aa2dc4d35003d784cf4","5e5d3aa2dc4d35003d784cf5","5e5d3aa2dc4d35003d784cf6","5e5d3aa2dc4d35003d784cf7","5e5d3aa2dc4d35003d784cf8","5e5d3aa2dc4d35003d784cf9","5e5d3aa2dc4d35003d784cfa","5e5d3aa2dc4d35003d784cfb","5e5d3aa2dc4d35003d784cfc","5e5d3aa2dc4d35003d784cfd","5e5d3aa2dc4d35003d784cfe","5e5d57ed1362cf0064910881","5e7a7ac40efab8003ae688c3"],"_id":"5e5d3aa2dc4d35003d784d9d","project":"57336fd5a6a9c40e00e13a0b","__v":2,"forked_from":"5c6c23e4735b81006177d0a4","createdAt":"2018-04-24T15:22:41.561Z","releaseDate":"2018-04-24T15:22:41.561Z"},"createdAt":"2016-01-05T18:54:35.186Z","githubsync":"","__v":0}

cardHolderInfo

Contains information about the credit card holder

Request

Property Name
Type
Required
Description

firstName

string

Required

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

Required

Cardholder's last name.
Maximum 100 characters.

email

string

Required for local LatAm processing only

Cardholder's email address.
Maximum 100 characters.

country

string

Optional

Cardholder's country code.
Refer to Country codes

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.

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.

zip

string

Optional

Cardholder's ZIP code.
Maximum 20 characters.

phone

string

Optional

Cardholder's phone number.
Maximum 36 characters.
Accepts numbers, letters, and these 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)

Response

Property Name
Type
Description

firstName

string

Cardholder's first name.
Maximum 100 characters.

lastName

string

Cardholder's last name.
Maximum 100 characters.

email

string

Cardholder's email address.
Maximum 100 characters.

country

string

Cardholder's country code.
Refer to Country codes

state

string

Cardholder's state code.
Refer to State and province codes

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.

zip

string

Cardholder's ZIP code.

phone

string

Cardholder's phone number.
Maximum 36 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)