{"_id":"5beec5a5f95d82011c6f368c","category":{"_id":"5beec5a5f95d82011c6f367e","version":"5beec5a5f95d82011c6f3714","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-10-15T16:20:51.519Z","from_sync":false,"order":12,"slug":"resources","title":"Resources"},"project":"57336fd5a6a9c40e00e13a0b","parentDoc":null,"user":"560d5913af97231900938124","version":{"_id":"5beec5a5f95d82011c6f3714","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5bcf37dfadc5b905136a39f4","createdAt":"2018-04-24T15:24:22.608Z","releaseDate":"2018-04-24T15:24:22.608Z","categories":["5beec5a5f95d82011c6f3672","5beec5a5f95d82011c6f3673","5beec5a5f95d82011c6f3674","5beec5a5f95d82011c6f3675","5beec5a5f95d82011c6f3676","5beec5a5f95d82011c6f3677","5beec5a5f95d82011c6f3678","5beec5a5f95d82011c6f3679","5beec5a5f95d82011c6f367a","5beec5a5f95d82011c6f367b","5beec5a5f95d82011c6f367c","5beec5a5f95d82011c6f367d","5beec5a5f95d82011c6f367e","5beec5a5f95d82011c6f367f","5beec5a5f95d82011c6f3680","5beec5a5f95d82011c6f3681"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"3.28 Release","version_clean":"8976.0.0-XML","version":"8976-XML"},"githubsync":"","__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-01-05T18:54:35.186Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":5,"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\": \"Optional\",\n    \"2-3\": \"Cardholder's email address.\\nBetween 3-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\": \"**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.\\nSee [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.\\nSee [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.\\nBetween 2-36 characters.\\nAccepts numbers, letters, and these characters: ** + . * # / \\\\ ( ) - **\",\n    \"7-3\": \"Cardholder's city.\\nBetween 2-42 characters.\",\n    \"8-3\": \"Cardholder's ZIP code. Maximum 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 chras)\\n  * Chile - RUN (length 8-9 chars)\\n  * Colombia - CC (length 6-10 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, up to 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\": \"`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.\\nBetween 3-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.\\nSee [Country codes](/docs/country-codes)\",\n    \"4-2\": \"Cardholder's state code.\\nSee [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.\\nBetween 2-42 characters.\",\n    \"8-2\": \"Cardholder's ZIP code.\",\n    \"9-2\": \"Cardholder's phone number.\\nBetween 2-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. These are the ID types per country:\\n\\n  * Argentina - DNI (length 7-11 chars)\\n  * Brazil - CPF/CNPJ (length 11-14 chras)\\n  * Chile - RUN (length 8-9 chars)\\n  * Colombia - CC (length 6-10 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, up to 50 characters.\"\n  },\n  \"cols\": 3,\n  \"rows\": 12\n}\n[/block]","excerpt":"Contains information about the credit card holder","slug":"card-holder-info","type":"basic","title":"card-holder-info"}

Payment API (XML)

Card/Wallet Transactions

PayPal Transactions

ACH/ECP Transactions

SEPA Direct Debit Transactions

Batch Transactions

Refunds

Vaulted Shoppers

Subscriptions

Marketplace

Wallets

Errors

Resources

Test Data & Codes

Guides & Tools

Mobile SDK

card-holder-info

Contains information about the credit card holder

Request

Property Name
Type
Required
Description

first-name

string

Required

Cardholder's first name.
Maximum 100 characters.

last-name

string

Required

Cardholder's last name.
Maximum 100 characters.

email

string

Optional

Cardholder's email address.
Between 3-100 characters.

country

string

Optional

Cardholder's country code.
See Country codes

state

string

Optional

Cardholder's state code.
See 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.
Between 2-42 characters.

zip

string

Optional

Cardholder's ZIP code. Maximum 20 characters.

phone

string

Optional

Cardholder's phone number.
Between 2-36 characters.
Accepts numbers, letters, and these characters: + . * # / \ ( ) -

merchant-shopper-id

string

Optional

A merchant's ID for a specific shopper, up to 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 chras)
  • Chile - RUN (length 8-9 chars)
  • Colombia - CC (length 6-10 chars)
  • Mexico - CURP/RFC (length 10-18 chars)

Response

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.
Between 3-100 characters.

country

string

Cardholder's country code.
See Country codes

state

string

Cardholder's state code.
See 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.
Between 2-42 characters.

zip

string

Cardholder's ZIP code.

phone

string

Cardholder's phone number.
Between 2-36 characters.

merchant-shopper-id

string

A merchant's ID for a specific shopper, up to 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 chras)
  • Chile - RUN (length 8-9 chars)
  • Colombia - CC (length 6-10 chars)
  • Mexico - CURP/RFC (length 10-18 chars)