{"_id":"59dfa5868b51880010b74b21","category":{"_id":"59dfa5828b51880010b74ac2","version":"59dfa5828b51880010b74ab6","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":"59dfa5828b51880010b74ab6","project":"57336fd5a6a9c40e00e13a0b","__v":1,"createdAt":"2017-10-12T17:25:22.850Z","releaseDate":"2017-10-12T17:25:22.850Z","categories":["59dfa5828b51880010b74ab7","59dfa5828b51880010b74ab8","59dfa5828b51880010b74ab9","59dfa5828b51880010b74aba","59dfa5828b51880010b74abb","59dfa5828b51880010b74abc","59dfa5828b51880010b74abd","59dfa5828b51880010b74abe","59dfa5828b51880010b74abf","59dfa5828b51880010b74ac0","59dfa5828b51880010b74ac1","59dfa5828b51880010b74ac2","59dfa5828b51880010b74ac3","59dfa5828b51880010b74ac4","59dfa5828b51880010b74ac5"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"3.23 Release","version_clean":"8976.0.0-JSON","version":"8976-JSON"},"__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-12-02T17:06:21.435Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":40,"body":"###Request\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Required\",\n    \"h-3\": \"Description\",\n    \"0-0\": \"`name`\",\n    \"1-0\": \"`firstName`\",\n    \"2-0\": \"`lastName`\",\n    \"4-0\": \"`phone`\",\n    \"5-0\": \"`address`\",\n    \"6-0\": \"`city`\",\n    \"7-0\": \"`country`\",\n    \"9-0\": \"`zip`\",\n    \"0-1\": \"*string*\",\n    \"1-1\": \"*string*\",\n    \"2-1\": \"*string*\",\n    \"4-1\": \"*string*\",\n    \"5-1\": \"*string*\",\n    \"6-1\": \"*string*\",\n    \"7-1\": \"*string*\",\n    \"9-1\": \"*string*\",\n    \"0-2\": \"optional\",\n    \"1-2\": \"optional\",\n    \"2-2\": \"optional\",\n    \"4-2\": \"optional\",\n    \"5-2\": \"optional\",\n    \"6-2\": \"optional\",\n    \"9-2\": \"optional\",\n    \"7-2\": \"**required**\",\n    \"0-3\": \"Vendor / Business name. Maximum 100 characters.\",\n    \"1-3\": \"Vendor first name. Maximum 40 characters.\",\n    \"2-3\": \"Vendor last name. Maximum 40 characters.\",\n    \"4-3\": \"Vendor phone. Maximum 30 characters.\",\n    \"5-3\": \"Vendor address. Maximum 60 characters.\",\n    \"6-3\": \"Vendor city. Maximum 40 characters.\",\n    \"9-3\": \"Vendor zip/postal code. Maximum 20 characters.\",\n    \"7-3\": \"Vendor country; See [Country codes](/v1.0/docs/country-codes)\",\n    \"15-0\": \"`vendorPrincipal`\",\n    \"15-1\": \"*container*\",\n    \"15-2\": \"optional\",\n    \"15-3\": \"Vendor principal; See [vendorPrincipal](doc:vendorprincipal)\",\n    \"3-0\": \"`email`\",\n    \"3-1\": \"*string*\",\n    \"3-2\": \"**required**\",\n    \"3-3\": \"Vendor email. Maximum 150 characters.\",\n    \"16-0\": \"`payoutInfo`\",\n    \"16-1\": \"*container*\",\n    \"16-2\": \"optional\",\n    \"16-3\": \"Payout info; See [payoutInfo](doc:payoutinfo).\",\n    \"8-0\": \"`state`\",\n    \"8-1\": \"*string*\",\n    \"8-2\": \"optional\\n\\napplicable if country = US or CA\",\n    \"8-3\": \"Vendor state/province\\n\\nSee [State and Province Codes](doc:state-and-province-codes)\",\n    \"17-0\": \"`vendorAgreement`\",\n    \"17-1\": \"*container*\",\n    \"17-2\": \"optional\",\n    \"17-3\": \"Vendor agreement; See [vendorAgreement](doc:vendoragreement)\",\n    \"10-0\": \"`taxId`\",\n    \"10-1\": \"*string*\",\n    \"10-2\": \"optional; do not include if sending `vatId`.\",\n    \"10-3\": \"The company’s business ID number. For example, EIN in the US, Business Number in Canada, Company Number in the UK, etc. Maximum 18 characters.\",\n    \"11-0\": \"`vatId`\",\n    \"11-1\": \"*string*\",\n    \"11-2\": \"optional; do not include if sending `taxId`\",\n    \"11-3\": \"The company’s VAT number. Maximum 18 characters.\",\n    \"12-0\": \"`defaultPayoutCurrency`\",\n    \"12-1\": \"*string*\",\n    \"12-2\": \"optional\",\n    \"12-3\": \"Vendor's default payout currency. If a sale occurs in a currency for which there is not an associated bank account, sale funds will be converted to this currency.\\n\\n Default value is **USD**. Allowable currency codes listed [here](/v1.0/docs/payout#section-vendor-payout-currencies). \\n\\n**Note**: Your vendor must have an associated bank account defined within `payoutInfo`.\",\n    \"13-0\": \"`frequency`\",\n    \"13-1\": \"*string*\",\n    \"13-2\": \"optional\",\n    \"13-3\": \"Vendor payout frequency. Default value is Marketplace Merchant's payout frequency. \\n\\nPossible values: \\nDAILY\\nWEEKLY\\nSEMIMONTHLY \\nMONTHLY\\n\\n**Note**: Your vendor's payout settings cannot result in quicker payout than your own.\",\n    \"14-0\": \"`delay`\",\n    \"14-1\": \"*integer*\",\n    \"14-2\": \"optional\",\n    \"14-3\": \"Vendor payout delay (in days). Default value is Marketplace Merchant's payout delay. \\n\\n**Note** Your vendor's payout settings cannot result in quicker payout than your own.\"\n  },\n  \"cols\": 4,\n  \"rows\": 18\n}\n[/block]\n###Response\nResponse contains request properties plus these additions: \n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`vendorId`\",\n    \"0-1\": \"*integer*\",\n    \"0-2\": \"ID assigned to vendor.  To be used on all transactions involving this vendor\",\n    \"1-0\": \"`verification`\",\n    \"1-1\": \"*object*\",\n    \"1-2\": \"Includes information about vendor payout and processing statuses. See [verification](doc:verification).\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]","excerpt":"","slug":"vendorinfo","type":"basic","title":"vendor"}

Request

Property Name
Type
Required
Description

name

string

optional

Vendor / Business name. Maximum 100 characters.

firstName

string

optional

Vendor first name. Maximum 40 characters.

lastName

string

optional

Vendor last name. Maximum 40 characters.

email

string

required

Vendor email. Maximum 150 characters.

phone

string

optional

Vendor phone. Maximum 30 characters.

address

string

optional

Vendor address. Maximum 60 characters.

city

string

optional

Vendor city. Maximum 40 characters.

country

string

required

Vendor country; See Country codes

state

string

optional

applicable if country = US or CA

Vendor state/province

See State and Province Codes

zip

string

optional

Vendor zip/postal code. Maximum 20 characters.

taxId

string

optional; do not include if sending vatId.

The company’s business ID number. For example, EIN in the US, Business Number in Canada, Company Number in the UK, etc. Maximum 18 characters.

vatId

string

optional; do not include if sending taxId

The company’s VAT number. Maximum 18 characters.

defaultPayoutCurrency

string

optional

Vendor's default payout currency. If a sale occurs in a currency for which there is not an associated bank account, sale funds will be converted to this currency.

Default value is USD. Allowable currency codes listed here.

Note: Your vendor must have an associated bank account defined within payoutInfo.

frequency

string

optional

Vendor payout frequency. Default value is Marketplace Merchant's payout frequency.

Possible values:
DAILY
WEEKLY
SEMIMONTHLY
MONTHLY

Note: Your vendor's payout settings cannot result in quicker payout than your own.

delay

integer

optional

Vendor payout delay (in days). Default value is Marketplace Merchant's payout delay.

Note Your vendor's payout settings cannot result in quicker payout than your own.

vendorPrincipal

container

optional

Vendor principal; See vendorPrincipal

payoutInfo

container

optional

Payout info; See payoutInfo.

vendorAgreement

container

optional

Vendor agreement; See vendorAgreement

Response

Response contains request properties plus these additions:

Property Name
Type
Description

vendorId

integer

ID assigned to vendor. To be used on all transactions involving this vendor

verification

object

Includes information about vendor payout and processing statuses. See verification.