{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","results":{"codes":[]},"settings":"","params":[]},"next":{"description":"","pages":[]},"title":"vendor","type":"basic","slug":"vendorinfo","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 \"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; refer to [Country codes](/docs/country-codes)\",\n \"16-0\": \"`vendorPrincipal`\",\n \"16-1\": \"*container*\",\n \"16-2\": \"optional\",\n \"16-3\": \"Vendor principal; refer to [vendorPrincipal](doc:vendorprincipal)\",\n \"3-0\": \"`email`\",\n \"3-1\": \"*string*\",\n \"3-2\": \"**required**\",\n \"3-3\": \"Vendor email. Maximum 150 characters.\",\n \"17-0\": \"`payoutInfo`\",\n \"17-1\": \"*container*\",\n \"17-2\": \"optional\",\n \"17-3\": \"Payout info; refer to [payoutInfo](doc:payoutinfo).\",\n \"8-0\": \"`state`\",\n \"8-1\": \"*string*\",\n \"8-2\": \"optional\\nApplicable if `country` = `US` or `CA`\",\n \"8-3\": \"Vendor state/province; refer to [State and Province Codes](doc:state-and-province-codes)\",\n \"19-0\": \"`vendorAgreement`\",\n \"19-1\": \"*container*\",\n \"19-2\": \"optional\",\n \"19-3\": \"Vendor agreement; refer to [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 \"13-0\": \"`defaultPayoutCurrency`\",\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 `payoutInfo`.\",\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\": \"`vendorUrl`\",\n \"12-1\": \"*string*\",\n \"12-2\": \"optional\",\n \"12-3\": \"The main URL for the vendor's business (usually the one accessed by customers).\",\n \"18-0\": \"`ipnUrl`\",\n \"18-1\": \"*string*\",\n \"18-2\": \"optional\",\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 },\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\": \"`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. Refer to [verification](doc:verification).\"\n },\n \"cols\": 3,\n \"rows\": 2\n}\n[/block]","updates":[],"order":51,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5f43d7db37d54d01d8ef0822","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"JSON Objects","slug":"resources","order":14,"from_sync":false,"reference":false,"_id":"5f43d7db37d54d01d8ef07d6","version":"5f43d7db37d54d01d8ef0876","project":"57336fd5a6a9c40e00e13a0b","createdAt":"2015-10-15T16:20:51.519Z","__v":0},"user":"560d5913af97231900938124","parentDoc":null,"project":"57336fd5a6a9c40e00e13a0b","version":{"version":"8976-JSON","version_clean":"8976.0.0-JSON","codename":"3.35 Release","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5f43d7db37d54d01d8ef07cb","5f43d7db37d54d01d8ef07cc","5f43d7db37d54d01d8ef07cd","5f43d7db37d54d01d8ef07ce","5f43d7db37d54d01d8ef07cf","5f43d7db37d54d01d8ef07d0","5f43d7db37d54d01d8ef07d1","5f43d7db37d54d01d8ef07d2","5f43d7db37d54d01d8ef07d3","5f43d7db37d54d01d8ef07d4","5f43d7db37d54d01d8ef07d5","5f43d7db37d54d01d8ef07d6","5f43d7db37d54d01d8ef07d7","5f43d7db37d54d01d8ef07d8","5f43d7db37d54d01d8ef07d9","5f43d7db37d54d01d8ef07da","5f43d7db37d54d01d8ef07db","5f45521ec5bfe9005a858533"],"_id":"5f43d7db37d54d01d8ef0876","project":"57336fd5a6a9c40e00e13a0b","__v":1,"forked_from":"5ed0377101fdb400214dedaa","createdAt":"2018-04-24T15:22:41.561Z","releaseDate":"2018-04-24T15:22:41.561Z"},"createdAt":"2016-12-02T17:06:21.435Z","githubsync":"","__v":0}vendor
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.
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.
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.
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.
vendorUrl
string
optional
The main URL for the vendor's business (usually the one accessed by customers).
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
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.
ipnUrl
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.
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. Refer to verification.
