{"_id":"5c6c23e4735b81006177d03c","category":{"_id":"5c6c23e4735b81006177d011","version":"5c6c23e4735b81006177d0a4","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-10-15T16:20:51.519Z","from_sync":false,"order":11,"slug":"resources","title":"JSON Objects"},"user":"560d5913af97231900938124","parentDoc":null,"project":"57336fd5a6a9c40e00e13a0b","version":{"_id":"5c6c23e4735b81006177d0a4","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5bedd214812951004a2ad9df","createdAt":"2018-04-24T15:22:41.561Z","releaseDate":"2018-04-24T15:22:41.561Z","categories":["5c6c23e4735b81006177d006","5c6c23e4735b81006177d007","5c6c23e4735b81006177d008","5c6c23e4735b81006177d009","5c6c23e4735b81006177d00a","5c6c23e4735b81006177d00b","5c6c23e4735b81006177d00c","5c6c23e4735b81006177d00d","5c6c23e4735b81006177d00e","5c6c23e4735b81006177d00f","5c6c23e4735b81006177d010","5c6c23e4735b81006177d011","5c6c23e4735b81006177d012","5c6c23e4735b81006177d013","5c6c23e4735b81006177d014"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"Main","version_clean":"8976.0.0-JSON","version":"8976-JSON"},"githubsync":"","__v":0,"metadata":{"title":"","description":"","image":[]},"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":3,"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\": \"First name for billing.\\nMaximum 100 characters.\",\n    \"1-0\": \"`lastName`\",\n    \"1-1\": \"*string*\",\n    \"1-3\": \"Last name for billing.\\nMaximum 100 characters.\",\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 within the `address1` or `address2` property.\",\n    \"5-1\": \"*string*\",\n    \"6-1\": \"*string*\",\n    \"6-3\": \"ZIP code for billing. \\nMaximum 20 characters.\",\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.\\nMaximum 100 characters.\",\n    \"3-3\": \"Address line 2 for billing.\\nBetween 2-42 characters.\",\n    \"4-0\": \"`city`\",\n    \"4-1\": \"*string*\",\n    \"4-3\": \"City for billing.\\nBetween 2-42 characters.\",\n    \"4-2\": \"**Required**\",\n    \"8-0\": \"`personalIdentificationNumber`\",\n    \"8-1\": \"*string*\",\n    \"8-2\": \"**Required** for [local LatAm processing](/docs/latam-local-processing) in Brazil; Optional for all other Latam countries.\",\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  * 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\": \"`firstName`\",\n    \"0-1\": \"*string*\",\n    \"h-3\": \"Description\",\n    \"0-3\": \"Cardholder's first name.\",\n    \"1-0\": \"`lastName`\",\n    \"1-1\": \"*string*\",\n    \"1-3\": \"Cardholder's last name.\",\n    \"h-4\": \"Description\",\n    \"0-2\": \"First name for billing.\\nMaximum 100 characters.\",\n    \"1-2\": \"Last name for billing.\\nMaximum 100 characters.\",\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.\\nBetween 2-42 characters.\",\n    \"5-2\": \"State code for billing.\\nSee [State and province codes](/docs/state-and-province-codes).\",\n    \"6-2\": \"ZIP code for billing.\\nMaximum 20 characters.\",\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.\\nMaximum 100 characters.\",\n    \"3-2\": \"Address line 2 for billing.\\nBetween 2-42 characters.\",\n    \"8-0\": \"`personalIdentificationNumber`\",\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  * 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":"billingContactInfo"}

Payment API (JSON)

Card/Wallet Transactions

PayPal Transactions

ACH/ECP Transactions

SEPA Direct Debit Transactions

Refunds

Vaulted Shoppers

Subscriptions

Marketplace

Wallets

Errors

JSON Objects

Test Data & Codes

Guides & Tools

Mobile SDK

billingContactInfo

Contains billing contact information

Request

Property Name
Type
Required
Description

firstName

string

Required

First name for billing.
Maximum 100 characters.

lastName

string

Required

Last name for billing.
Maximum 100 characters.

address1

string

Required

Address line 1 for billing.
Maximum 100 characters.

address2

string

Optional

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

city

string

Required

City for billing.
Between 2-42 characters.

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 within the address1 or address2 property.

zip

string

Required

ZIP code for billing.
Maximum 20 characters.

country

string

Required

Country code for billing.
See Country codes.

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 chras)
  • Chile - RUN (length 8-9 chars)
  • Mexico - CURP/RFC (length 10-18 chars)

Response

Property Name
Type
Description

firstName

string

First name for billing.
Maximum 100 characters.

lastName

string

Last name for billing.
Maximum 100 characters.

address1

string

Address line 1 for billing.
Maximum 100 characters.

address2

string

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

city

string

City for billing.
Between 2-42 characters.

state

string

State code for billing.
See State and province codes.

zip

string

ZIP code for billing.
Maximum 20 characters.

country

string

Country code for billing.
See Country codes.

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 chras)
  • Chile - RUN (length 8-9 chars)
  • Mexico - CURP/RFC (length 10-18 chars)