shopper-contact-info

{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","results":{"codes":[]},"settings":"","params":[]},"next":{"description":"","pages":[]},"title":"shopper-contact-info","type":"basic","slug":"shopper-contact-info","excerpt":"","body":"###Request\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Property Name\",\n \"h-1\": \"Type\",\n \"h-2\": \"Required\",\n \"1-0\": \"`first-name`\",\n \"1-1\": \"*string*\",\n \"h-3\": \"Description\",\n \"1-3\": \"Shopper's first name.\",\n \"3-0\": \"`email`\",\n \"3-2\": \"**Required**\",\n \"3-3\": \"Shopper's email address.\",\n \"3-1\": \"*string*\",\n \"2-0\": \"`last-name`\",\n \"2-1\": \"*string*\",\n \"2-3\": \"Shopper's last name (family name).\",\n \"3-4\": \"A container of card-transaction properties.\\nThis property may appear more than once within the given resource.\",\n \"h-4\": \"Description\",\n \"1-2\": \"**Required**\",\n \"2-2\": \"**Required**\",\n \"10-0\": \"`country`\",\n \"10-1\": \"*string*\",\n \"11-0\": \"`phone`\",\n \"10-3\": \"Shopper's country code.\\nSee [Country codes](/docs/country-codes).\",\n \"10-2\": \"**Required**\",\n \"11-2\": \"**Required**\",\n \"11-3\": \"Shopper's phone number.\\n\\nBetween 2-36 characters.\\nAccepts numbers, letters, and these characters: ** + . * # / \\\\ ( ) - **\",\n \"11-1\": \"*string*\",\n \"0-0\": \"`title`\",\n \"0-3\": \"Shopper's title.\",\n \"0-2\": \"Optional\",\n \"0-1\": \"*string*\",\n \"4-3\": \"Name of shopper's company.\\nMaximum 50 characters.\\n\\n**Note:** Required, if payment type is ECP and `account-type` is:\\n\\n* CORPORATE_CHECKING\\n* CORPORATE_SAVINGS\",\n \"4-2\": \"Optional\",\n \"4-1\": \"*string*\",\n \"4-0\": \"`company-name`\",\n \"5-0\": \"`address1`\",\n \"6-0\": \"`address2`\",\n \"5-1\": \"*string*\",\n \"6-1\": \"*string*\",\n \"6-2\": \"Optional\",\n \"5-2\": \"**Required**\",\n \"5-3\": \"First line of the shopper's address. Maximum 100 characters.\",\n \"6-3\": \"Second line of the shopper's address. Maximum 100 characters.\",\n \"7-0\": \"`city`\",\n \"7-1\": \"*string*\",\n \"7-2\": \"**Required**\",\n \"7-3\": \"Shopper's city.\",\n \"8-0\": \"`state`\",\n \"8-1\": \"*string*\",\n \"8-3\": \"Shopper'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 in the address property.\",\n \"8-2\": \"Optional\",\n \"9-3\": \"Shopper's ZIP code.\",\n \"9-2\": \"**Required**\",\n \"9-1\": \"*string*\",\n \"9-0\": \"`zip`\",\n \"12-0\": \"`fax`\",\n \"12-1\": \"*string*\",\n \"12-2\": \"Optional\",\n \"12-3\": \"Shopper's fax number.\",\n \"13-0\": \"`personal-identification-number`\",\n \"13-1\": \"*string*\",\n \"13-2\": \"**Required** for [local LatAm processing](/docs/latam-local-processing) in Brazil; Optional for all other Latam countries.\",\n \"13-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 },\n \"cols\": 4,\n \"rows\": 14\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 \"1-0\": \"`first-name`\",\n \"1-1\": \"*string*\",\n \"h-3\": \"Description\",\n \"1-3\": \"\",\n \"3-0\": \"`email`\",\n \"3-2\": \"Shopper's email address.\",\n \"3-3\": \"\",\n \"3-1\": \"*string*\",\n \"2-0\": \"`last-name`\",\n \"2-1\": \"*string*\",\n \"2-3\": \"\",\n \"3-4\": \"A container of card-transaction properties.\\nThis property may appear more than once within the given resource.\",\n \"h-4\": \"Description\",\n \"1-2\": \"Shopper's first name.\",\n \"2-2\": \"Shopper's last name (family name).\",\n \"10-0\": \"`country`\",\n \"10-1\": \"*string*\",\n \"11-0\": \"`phone`\",\n \"10-3\": \"\",\n \"10-2\": \"Shopper's country code.\\nSee [Country codes](/docs/country-codes).\",\n \"11-2\": \"Shopper's phone number.\",\n \"11-3\": \"\",\n \"11-1\": \"*string*\",\n \"0-0\": \"`title`\",\n \"0-3\": \"\",\n \"0-2\": \"Shopper's title.\",\n \"0-1\": \"*string*\",\n \"4-3\": \"\",\n \"4-2\": \"Shopper's company name.\",\n \"4-1\": \"*string*\",\n \"4-0\": \"`company-name`\",\n \"5-0\": \"`address1`\",\n \"6-0\": \"`address2`\",\n \"5-1\": \"*string*\",\n \"6-1\": \"*string*\",\n \"6-2\": \"Second line of the shopper's address. Maximum 100 characters.\",\n \"5-2\": \"First line of the shopper's address. Maximum 100 characters.\",\n \"5-3\": \"\",\n \"6-3\": \"\",\n \"7-0\": \"`city`\",\n \"7-1\": \"*string*\",\n \"7-2\": \"Shopper's city.\",\n \"7-3\": \"\",\n \"8-0\": \"`state`\",\n \"8-1\": \"*string*\",\n \"8-3\": \"\",\n \"8-2\": \"Shopper'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 recommended to include the state in the address property.\",\n \"9-3\": \"\",\n \"9-2\": \"Shopper's ZIP code.\",\n \"9-1\": \"*string*\",\n \"9-0\": \"`zip`\",\n \"12-0\": \"`fax`\",\n \"12-1\": \"*string*\",\n \"12-2\": \"Shopper's fax number.\",\n \"12-3\": \"\",\n \"13-1\": \"*string*\",\n \"13-0\": \"`personal-identification-number`\",\n \"13-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 },\n \"cols\": 3,\n \"rows\": 14\n}\n[/block]","updates":[],"order":91,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5c742637ad58c70033b9c733","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Resources","slug":"resources","order":8,"from_sync":false,"reference":false,"_id":"5c742637ad58c70033b9c6a1","version":"5c742637ad58c70033b9c762","project":"57336fd5a6a9c40e00e13a0b","createdAt":"2015-10-15T16:20:51.519Z","__v":0},"parentDoc":null,"project":"57336fd5a6a9c40e00e13a0b","user":"560d5913af97231900938124","version":{"version":"8976-Extended","version_clean":"8976.0.0-Extended","codename":"Main","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5c742637ad58c70033b9c699","5c742637ad58c70033b9c69a","5c742637ad58c70033b9c69b","5c742637ad58c70033b9c69c","5c742637ad58c70033b9c69d","5c742637ad58c70033b9c69e","5c742637ad58c70033b9c69f","5c742637ad58c70033b9c6a0","5c742637ad58c70033b9c6a1","5c742637ad58c70033b9c6a2","5c742637ad58c70033b9c6a3"],"_id":"5c742637ad58c70033b9c762","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5bedbcf19b49e8004462d199","createdAt":"2018-04-24T15:33:45.744Z","releaseDate":"2018-04-24T15:33:45.744Z"},"createdAt":"2016-06-28T12:05:08.331Z","githubsync":"","__v":0}

Request

Property Name

Type

Required

Description

title

string

Optional

Shopper's title.

first-name

string

Required

Shopper's first name.

last-name

string

Required

Shopper's last name (family name).

email

string

Required

Shopper's email address.

company-name

string

Optional

Name of shopper's company.
Maximum 50 characters.

Note: Required, if payment type is ECP and account-type is:

CORPORATE_CHECKING
CORPORATE_SAVINGS

address1

string

Required

First line of the shopper's address. Maximum 100 characters.

address2

string

Optional

Second line of the shopper's address. Maximum 100 characters.

city

string

Required

Shopper's city.

state

string

Optional

Shopper'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 in the address property.

zip

string

Required

Shopper's ZIP code.

country

string

Required

Shopper's country code.
See Country codes.

phone

string

Required

Shopper's phone number.

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

fax

string

Optional

Shopper's fax number.

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

title

string

Shopper's title.

first-name

string

Shopper's first name.

last-name

string

Shopper's last name (family name).

email

string

Shopper's email address.

company-name

string

Shopper's company name.

address1

string

First line of the shopper's address. Maximum 100 characters.

address2

string

Second line of the shopper's address. Maximum 100 characters.

city

string

Shopper's city.

state

string

Shopper's state code.
See State and province codes.
Supports US and Canada states only. For states in other countries, it is recommended to include the state in the address property.

zip

string

Shopper's ZIP code.

country

string

Shopper's country code.
See Country codes.

phone

string

Shopper's phone number.

fax

string

Shopper's fax number.

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)

Developer Hub

Extended Payment API

Orders

Shopping Context

Shoppers

Catalog

Subscriptions

Wallets

Errors

Resources

Test Data & Codes

Guides & Tools

Request

Response