{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","results":{"codes":[]},"settings":"","params":[]},"next":{"description":"","pages":[]},"title":"card-holder-info","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\": \"`first-name`\",\n \"0-1\": \"*string*\",\n \"h-3\": \"Description\",\n \"0-3\": \"Cardholder's first name.\\nMaximum 100 characters.\",\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\": \"`last-name`\",\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\": \"Optional\",\n \"1-2\": \"Optional\",\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\": \"`personal-identification-number`\",\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\": \"`merchant-shopper-id`\",\n \"10-1\": \"*string*\",\n \"10-2\": \"Optional\",\n \"10-3\": \"A merchant's ID for a specific shopper. \\nMaximum 50 characters.\",\n \"12-0\": \"`company-name`\",\n \"12-1\": \"*string*\",\n \"12-2\": \"Optional\",\n \"12-3\": \"The cardholder's company name. Maximum 100 characters.\"\n },\n \"cols\": 4,\n \"rows\": 13\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\": \"`first-name`\",\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\": \"`last-name`\",\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-0\": \"`personal-identification-number`\",\n \"11-1\": \"*string*\",\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 \"10-0\": \"`merchant-shopper-id`\",\n \"10-1\": \"*string*\",\n \"10-2\": \"A merchant's ID for a specific shopper.\\nMaximum 50 characters.\",\n \"12-0\": \"`company-name`\",\n \"12-1\": \"*string*\",\n \"12-2\": \"The cardholder's company name. Maximum 100 characters.\"\n },\n \"cols\": 3,\n \"rows\": 13\n}\n[/block]","updates":[],"order":6,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"61a5208deadb750070998ea5","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Resources","slug":"resources","order":16,"from_sync":false,"reference":false,"_id":"61a5208deadb750070998e93","version":"61a5208deadb750070998f48","project":"57336fd5a6a9c40e00e13a0b","createdAt":"2015-10-15T16:20:51.519Z","__v":0},"project":"57336fd5a6a9c40e00e13a0b","parentDoc":null,"user":"560d5913af97231900938124","version":{"version":"8976-XML","version_clean":"8976.0.0-XML","codename":"3.40 Release","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["61a5208deadb750070998e87","61a5208deadb750070998e88","61a5208deadb750070998e89","61a5208deadb750070998e8a","61a5208deadb750070998e8b","61a5208deadb750070998e8c","61a5208deadb750070998e8d","61a5208deadb750070998e8e","61a5208deadb750070998e8f","61a5208deadb750070998e90","61a5208deadb750070998e91","61a5208deadb750070998e92","61a5208deadb750070998e93","61a5208deadb750070998e94","61a5208deadb750070998e95","61a5208deadb750070998e96","61a5208deadb750070998e97","61a5208deadb750070998e98","61a5208deadb750070998e99","61a5208deadb750070998e9a"],"_id":"61a5208deadb750070998f48","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"60fed269718a45001c25b4a0","createdAt":"2018-04-24T15:24:22.608Z","releaseDate":"2018-04-24T15:24:22.608Z"},"createdAt":"2016-01-05T18:54:35.186Z","githubsync":"","__v":0}card-holder-info
Contains information about the credit card holder
Property Name
Type
Required
Description
first-name
string
Optional
Cardholder's first name.
Maximum 100 characters.
last-name
string
Optional
Cardholder's last name.
Maximum 100 characters.
email
string
Required for local LatAm processing only
Cardholder's email address.
Maximum 100 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.
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: + . * # / \ ( ) –“
merchant-shopper-id
string
Optional
A merchant's ID for a specific shopper.
Maximum 50 characters.
personal-identification-number
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)
company-name
string
Optional
The cardholder's company name. Maximum 100 characters.
Property Name
Type
Description
first-name
string
Cardholder's first name.
Maximum 100 characters.
last-name
string
Cardholder's last name.
Maximum 100 characters.
email
string
Cardholder's email address.
Maximum 100 characters.
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.
merchant-shopper-id
string
A merchant's ID for a specific shopper.
Maximum 50 characters.
personal-identification-number
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)
company-name
string
The cardholder's company name. Maximum 100 characters.
