{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","results":{"codes":[]},"settings":"","params":[]},"next":{"description":"","pages":[]},"title":"vendor","type":"basic","slug":"vendor","excerpt":"","body":"###Request\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"Initially, you do not need all your vendor's information to submit the request to immediately begin processing transactions; **however**, to fully board your vendor, you must collect all the necessary Know Your Customer (KYC), banking, and any additional required information from them, and submit to BlueSnap for verification.\",\n  \"title\": \"Vendor requirements\"\n}\n[/block]\n\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. Maximum 100 characters.\",\n    \"1-0\": \"`first-name`\",\n    \"1-1\": \"*string*\",\n    \"1-2\": \"Optional\",\n    \"1-3\": \"Vendor first name. Maximum 40 characters.\",\n    \"2-0\": \"`last-name`\",\n    \"2-1\": \"*string*\",\n    \"2-2\": \"Optional\",\n    \"2-3\": \"Vendor last name. Maximum 40 characters.\",\n    \"4-0\": \"`phone`\",\n    \"4-1\": \"*string*\",\n    \"4-2\": \"Optional\",\n    \"4-3\": \"Vendor phone number. Maximum 30 characters.\",\n    \"5-0\": \"`address`\",\n    \"5-1\": \"*string*\",\n    \"5-2\": \"Optional\",\n    \"5-3\": \"Vendor address. Maximum 60 characters.\",\n    \"6-0\": \"`city`\",\n    \"6-1\": \"*string*\",\n    \"6-2\": \"Optional\",\n    \"6-3\": \"Vendor city. Maximum 40 characters.\",\n    \"7-0\": \"`country`\",\n    \"7-1\": \"*string*\",\n    \"7-2\": \"**Required**\",\n    \"7-3\": \"Vendor country; refer to [Country codes](/docs/country-codes)\",\n    \"9-0\": \"`zip`\",\n    \"9-1\": \"*string*\",\n    \"9-2\": \"Optional\",\n    \"9-3\": \"Vendor zip/postal code. Maximum 20 characters.\",\n    \"3-0\": \"`email`\",\n    \"3-1\": \"*string*\",\n    \"3-2\": \"**Required**\",\n    \"3-3\": \"Vendor email. Maximum 150 characters.\",\n    \"8-0\": \"`state`\",\n    \"8-1\": \"*string*\",\n    \"8-2\": \"Optional \\nApplicable if `country` = `US` or `CA`\",\n    \"16-0\": \"`vendor-principal`\",\n    \"16-1\": \"*container*\",\n    \"16-2\": \"Optional\",\n    \"8-3\": \"Vendor state/province; refer to [State and Province Codes](doc:state-and-province-codes)\",\n    \"16-3\": \"Vendor principal; refer to [vendor-principal](doc:vendor-principal)\",\n    \"17-0\": \"`payout-info`\",\n    \"17-1\": \"*container*\",\n    \"17-2\": \"Optional\",\n    \"17-3\": \"Payout info; refer to [payout-info](doc:payout-info)\",\n    \"19-0\": \"`vendor-agreement`\",\n    \"19-1\": \"*container*\",\n    \"19-2\": \"Optional\",\n    \"19-3\": \"Vendor agreement; refer to [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.. Maximum 18 characters.\",\n    \"11-3\": \"The company’s VAT number. Maximum 18 characters.\",\n    \"13-0\": \"`default-payout-currency`\",\n    \"13-1\": \"*string*\",\n    \"13-2\": \"Optional\",\n    \"13-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](/docs/payout#section-vendor-payout-currencies). \\n\\n**Note**: Your vendor must have an associated bank account defined within `payout-info`.\",\n    \"14-0\": \"`frequency`\",\n    \"14-1\": \"*string*\",\n    \"14-2\": \"Optional\",\n    \"14-3\": \"Vendor payout frequency. Default value is Marketplace Merchant's payout frequency. \\n\\nPossible values: \\nDAILY\\nWEEKLY\\nMONTHLY\\n\\n**Note**: Your vendor's payout settings cannot result in quicker payout than your own.\",\n    \"15-0\": \"`delay`\",\n    \"15-1\": \"*integer*\",\n    \"15-2\": \"Optional\",\n    \"15-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    \"12-0\": \"`vendor-url`\",\n    \"12-2\": \"Optional\",\n    \"12-1\": \"*string*\",\n    \"12-3\": \"The main URL for the vendor's business (usually the one accessed by customers).\",\n    \"18-3\": \"This determines where the [Payout IPN](https://support.bluesnap.com/docs/ipns-name-reference#PAYOUT) is sent.  Enter the merchant's [IPN URL](https://support.bluesnap.com/docs/ipn-setup) if the Payout IPN should be sent to the merchant.\",\n    \"18-0\": \"`ipn-url`\",\n    \"18-1\": \"*string*\",\n    \"18-2\": \"Optional\"\n  },\n  \"cols\": 4,\n  \"rows\": 20\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. Refer to [verification](doc:verification).\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]","updates":[],"order":53,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5ed5174637c3c607440c09ca","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Resources","slug":"resources","order":14,"from_sync":false,"reference":false,"_id":"5ed5174637c3c607440c0997","version":"5ed5174637c3c607440c0a3c","project":"57336fd5a6a9c40e00e13a0b","createdAt":"2015-10-15T16:20:51.519Z","__v":0},"user":"560d5913af97231900938124","parentDoc":null,"project":"57336fd5a6a9c40e00e13a0b","version":{"version":"8976-XML","version_clean":"8976.0.0-XML","codename":"3.34.0 Release","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5ed5174637c3c607440c098b","5ed5174637c3c607440c098c","5ed5174637c3c607440c098d","5ed5174637c3c607440c098e","5ed5174637c3c607440c098f","5ed5174637c3c607440c0990","5ed5174637c3c607440c0991","5ed5174637c3c607440c0992","5ed5174637c3c607440c0993","5ed5174637c3c607440c0994","5ed5174637c3c607440c0995","5ed5174637c3c607440c0996","5ed5174637c3c607440c0997","5ed5174637c3c607440c0998","5ed5174637c3c607440c0999","5ed5174637c3c607440c099a","5ed5174637c3c607440c099b","5ed5174637c3c607440c099c"],"_id":"5ed5174637c3c607440c0a3c","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5e5d3a02fb6fb40050cb3c15","createdAt":"2018-04-24T15:24:22.608Z","releaseDate":"2018-04-24T15:24:22.608Z"},"createdAt":"2016-11-28T17:45:01.969Z","githubsync":"","__v":0}

Request

Vendor requirements

Initially, you do not need all your vendor's information to submit the request to immediately begin processing transactions; however, to fully board your vendor, you must collect all the necessary Know Your Customer (KYC), banking, and any additional required information from them, and submit to BlueSnap for verification.

Property Name
Type
Required
Description

name

string

Optional

Vendor / Business name. Maximum 100 characters.

first-name

string

Optional

Vendor first name. Maximum 40 characters.

last-name

string

Optional

Vendor last name. Maximum 40 characters.

email

string

Required

Vendor email. Maximum 150 characters.

phone

string

Optional

Vendor phone number. Maximum 30 characters.

address

string

Optional

Vendor address. Maximum 60 characters.

city

string

Optional

Vendor city. Maximum 40 characters.

country

string

Required

Vendor country; refer to Country codes

state

string

Optional
Applicable if country = US or CA

Vendor state/province; refer to State and Province Codes

zip

string

Optional

Vendor zip/postal code. Maximum 20 characters.

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.. Maximum 18 characters.

vat-id

string

Optional; do not include if sending tax-id

The company’s VAT number. Maximum 18 characters.

vendor-url

string

Optional

The main URL for the vendor's business (usually the one accessed by customers).

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
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; refer to vendor-principal

payout-info

container

Optional

Payout info; refer to payout-info

ipn-url

string

Optional

This determines where the Payout IPN is sent. Enter the merchant's IPN URL if the Payout IPN should be sent to the merchant.

vendor-agreement

container

Optional

Vendor agreement; refer to 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. Refer to verification.