{"_id":"59a45d467ee621000fc9d436","category":{"_id":"59a45d447ee621000fc9d3c4","version":"59a45d437ee621000fc9d3b7","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"},"user":"560d5913af97231900938124","parentDoc":null,"project":"57336fd5a6a9c40e00e13a0b","version":{"_id":"59a45d437ee621000fc9d3b7","project":"57336fd5a6a9c40e00e13a0b","__v":1,"createdAt":"2017-08-28T18:13:23.840Z","releaseDate":"2017-08-28T18:13:23.840Z","categories":["59a45d447ee621000fc9d3b8","59a45d447ee621000fc9d3b9","59a45d447ee621000fc9d3ba","59a45d447ee621000fc9d3bb","59a45d447ee621000fc9d3bc","59a45d447ee621000fc9d3bd","59a45d447ee621000fc9d3be","59a45d447ee621000fc9d3bf","59a45d447ee621000fc9d3c0","59a45d447ee621000fc9d3c1","59a45d447ee621000fc9d3c2","59a45d447ee621000fc9d3c3","59a45d447ee621000fc9d3c4","59a45d447ee621000fc9d3c5","59a45d447ee621000fc9d3c6","59a45d447ee621000fc9d3c7"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"3.22.1","version_clean":"8976.0.0-XML","version":"8976-XML"},"__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-11-28T17:45:01.969Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":91,"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    \"0-1\": \"*string*\",\n    \"0-2\": \"Optional\",\n    \"0-3\": \"Vendor / Business name\",\n    \"1-0\": \"`first-name`\",\n    \"1-1\": \"*string*\",\n    \"1-2\": \"Optional\",\n    \"1-3\": \"Vendor first name\",\n    \"2-0\": \"`last-name`\",\n    \"2-1\": \"*string*\",\n    \"2-2\": \"Optional\",\n    \"2-3\": \"Vendor last name\",\n    \"4-0\": \"`phone`\",\n    \"4-1\": \"*string*\",\n    \"4-2\": \"Optional\",\n    \"4-3\": \"Vendor phone number\",\n    \"5-0\": \"`address`\",\n    \"5-1\": \"*string*\",\n    \"5-2\": \"Optional\",\n    \"5-3\": \"Vendor address\",\n    \"6-0\": \"`city`\",\n    \"6-1\": \"*string*\",\n    \"6-2\": \"Optional\",\n    \"6-3\": \"Vendor city\",\n    \"7-0\": \"`country`\",\n    \"7-1\": \"*string*\",\n    \"7-2\": \"**Required**\",\n    \"7-3\": \"Vendor country; See [Country codes](/v1.0/docs/country-codes)\",\n    \"9-0\": \"`zip`\",\n    \"9-1\": \"*string*\",\n    \"9-2\": \"Optional\",\n    \"9-3\": \"Vendor zip/postal code\",\n    \"3-0\": \"`email`\",\n    \"3-1\": \"*string*\",\n    \"3-2\": \"**Required**\",\n    \"3-3\": \"Vendor email\",\n    \"8-0\": \"`state`\",\n    \"8-1\": \"*string*\",\n    \"8-2\": \"Optional \\n\\nApplicable if country = US or CA\",\n    \"15-0\": \"`vendor-principal`\",\n    \"15-1\": \"*container*\",\n    \"15-2\": \"Optional\",\n    \"8-3\": \"Vendor state/province \\n\\nSee [State and Province Codes](doc:state-and-province-codes)\",\n    \"15-3\": \"Vendor principal; See [vendor-principal](doc:vendor-principal)\",\n    \"16-0\": \"`payout-info`\",\n    \"16-1\": \"*container*\",\n    \"16-2\": \"Optional\",\n    \"16-3\": \"Payout info; See [payout-info](doc:payout-info)\",\n    \"17-0\": \"`vendor-agreement`\",\n    \"17-1\": \"*container*\",\n    \"17-2\": \"Optional\",\n    \"17-3\": \"Vendor agreement; See [vendor-agreement](doc:vendor-agreement)\",\n    \"10-0\": \"`tax-id`\",\n    \"10-1\": \"*string*\",\n    \"10-2\": \"Optional; do not include if sending `vat-id`.\",\n    \"11-0\": \"`vat-id`\",\n    \"11-1\": \"*string*\",\n    \"11-2\": \"Optional; do not include if sending `tax-id`.\",\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.\",\n    \"11-3\": \"The company’s VAT number.\",\n    \"12-0\": \"`default-payout-currency`\",\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\\nDefault 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 `payout-info`.\",\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\": \"`vendor-id`\",\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\": \"*container*\",\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":"vendor","type":"basic","title":"vendor"}

Request

Property Name
Type
Required
Description

name

string

Optional

Vendor / Business name

first-name

string

Optional

Vendor first name

last-name

string

Optional

Vendor last name

email

string

Required

Vendor email

phone

string

Optional

Vendor phone number

address

string

Optional

Vendor address

city

string

Optional

Vendor city

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

tax-id

string

Optional; do not include if sending vat-id.

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

vat-id

string

Optional; do not include if sending tax-id.

The company’s VAT number.

default-payout-currency

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 payout-info.

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.

vendor-principal

container

Optional

Vendor principal; See vendor-principal

payout-info

container

Optional

Payout info; See payout-info

vendor-agreement

container

Optional

Vendor agreement; See vendor-agreement

Response

Response contains request properties plus these additions:

Property Name
Type
Description

vendor-id

integer

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

verification

container

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