{"_id":"5bedbcf19b49e8004462d117","category":{"_id":"5bedbcf09b49e8004462d0d8","version":"5bedbcf19b49e8004462d199","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-10-15T16:20:51.519Z","from_sync":false,"order":8,"slug":"resources","title":"Resources"},"user":"560d5913af97231900938124","project":"57336fd5a6a9c40e00e13a0b","parentDoc":null,"version":{"_id":"5bedbcf19b49e8004462d199","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5bcf3922e8455d049c357ed7","createdAt":"2018-04-24T15:33:45.744Z","releaseDate":"2018-04-24T15:33:45.744Z","categories":["5bedbcf09b49e8004462d0d0","5bedbcf09b49e8004462d0d1","5bedbcf09b49e8004462d0d2","5bedbcf09b49e8004462d0d3","5bedbcf09b49e8004462d0d4","5bedbcf09b49e8004462d0d5","5bedbcf09b49e8004462d0d6","5bedbcf09b49e8004462d0d7","5bedbcf09b49e8004462d0d8","5bedbcf09b49e8004462d0d9","5bedbcf09b49e8004462d0da"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"3.28 Release","version_clean":"8976.0.0-Extended","version":"8976-Extended"},"githubsync":"","__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-01-06T12:23:00.132Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":4,"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\": \"First name for billing.\",\n    \"1-0\": \"`last-name`\",\n    \"1-1\": \"*string*\",\n    \"1-3\": \"Last name for billing.\",\n    \"h-4\": \"Description\",\n    \"0-2\": \"**Required**\",\n    \"1-2\": \"**Required**\",\n    \"5-0\": \"`state`\",\n    \"6-0\": \"`zip`\",\n    \"5-3\": \"State code for billing.\\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    \"5-1\": \"*string*\",\n    \"6-1\": \"*string*\",\n    \"6-3\": \"ZIP code for billing.\",\n    \"5-2\": \"Optional\",\n    \"6-2\": \"**Required**\",\n    \"7-0\": \"`country`\",\n    \"7-1\": \"*string*\",\n    \"7-2\": \"**Required**\",\n    \"7-3\": \"Country code for billing.\\nSee [Country codes](/docs/country-codes).\",\n    \"2-0\": \"`address1`\",\n    \"3-0\": \"`address2`\",\n    \"2-1\": \"*string*\",\n    \"3-1\": \"*string*\",\n    \"2-2\": \"**Required**\",\n    \"3-2\": \"Optional\",\n    \"2-3\": \"Address line 1 for billing.\\nBetween 2-42 characters.\",\n    \"3-3\": \"Address line 2 for billing.\",\n    \"4-0\": \"`city`\",\n    \"4-1\": \"*string*\",\n    \"4-3\": \"City for billing.\",\n    \"4-2\": \"**Required**\",\n    \"8-0\": \"`personal-identification-number`\",\n    \"8-1\": \"*string*\",\n    \"8-2\": \"Required for [local LatAm processing](/docs/latam-local-processing) in Brazil\",\n    \"8-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\": 9\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    \"1-0\": \"`last-name`\",\n    \"1-1\": \"*string*\",\n    \"1-3\": \"Cardholder's last name.\",\n    \"h-4\": \"Description\",\n    \"0-2\": \"First name for billing.\",\n    \"1-2\": \"Last name for billing.\",\n    \"4-0\": \"`city`\",\n    \"4-1\": \"*string*\",\n    \"5-0\": \"`state`\",\n    \"6-0\": \"`zip`\",\n    \"5-3\": \"Cardholder's state code.\\n\\nADD LINK TO LIST OF STATE CODES\",\n    \"5-1\": \"*string*\",\n    \"6-1\": \"*string*\",\n    \"6-3\": \"Cardholder's address.\",\n    \"4-3\": \"Cardholder's country code.\\n\\nADD LINK TO LIST OF COUNTRY CODES\",\n    \"4-2\": \"City for billing.\",\n    \"5-2\": \"State code for billing.\\nSee [State and province codes](/docs/state-and-province-codes).\",\n    \"6-2\": \"ZIP code for billing.\",\n    \"7-0\": \"`country`\",\n    \"7-1\": \"*string*\",\n    \"7-2\": \"Country code for billing.\\nSee [Country codes](/docs/country-codes).\",\n    \"3-0\": \"`address2`\",\n    \"2-0\": \"`address1`\",\n    \"2-1\": \"*string*\",\n    \"3-1\": \"*string*\",\n    \"2-2\": \"Address line 1 for billing.\\nBetween 2-42 characters.\",\n    \"3-2\": \"Address line 2 for billing.\",\n    \"8-0\": \"`personal-identification-number`\",\n    \"8-1\": \"*string*\",\n    \"8-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\": 9\n}\n[/block]","excerpt":"Contains billing contact information","slug":"billing-contact-info","type":"basic","title":"billing-contact-info"}

Extended Payment API

Orders

Shopping Context

Shoppers

Catalog

Subscriptions

Wallets

Errors

Resources

Test Data & Codes

Guides & Tools

billing-contact-info

Contains billing contact information

Request

Property Name
Type
Required
Description

first-name

string

Required

First name for billing.

last-name

string

Required

Last name for billing.

address1

string

Required

Address line 1 for billing.
Between 2-42 characters.

address2

string

Optional

Address line 2 for billing.

city

string

Required

City for billing.

state

string

Optional

State code for billing.
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

ZIP code for billing.

country

string

Required

Country code for billing.
See Country codes.

personal-identification-number

string

Required for local LatAm processing in Brazil

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

First name for billing.

last-name

string

Last name for billing.

address1

string

Address line 1 for billing.
Between 2-42 characters.

address2

string

Address line 2 for billing.

city

string

City for billing.

state

string

State code for billing.
See State and province codes.

zip

string

ZIP code for billing.

country

string

Country code for billing.
See Country codes.

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)