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
`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
`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`.
`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.
`email`	string	Required	Vendor email. Maximum 150 characters. "+" character is not permitted.
`first-name`	string	Optional	Vendor first name. Maximum 40 characters.
`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.
`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.
`last-name`	string	Optional	Vendor last name. Maximum 40 characters.
`name`	string	Optional	Vendor / Business name. Maximum 100 characters.
`payout-info`	container	Optional	Payout info; refer to payout-info
`phone`	string	Optional	Vendor phone number. Maximum 30 characters.
`state`	string	Optional Applicable if `country` = `US` or `CA`	Vendor state/province; refer to State and Province Codes
`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.
`terms-of-service`	container	Required Create Vendor requests only	Information indicating that the vendor has accepted the BlueSnap Vendor Agreement; refer to terms-of-service
`vat-id`	string	Optional; do not include if sending `tax-id`	The company’s VAT number. Maximum 18 characters.
`vendor-agreement`	container	Optional	Vendor commission details; refer to vendor-agreement
`vendor-principal`	container	Optional	Vendor principal; refer to vendor-principal
`vendor-url`	string	Optional	The main URL for the vendor's business (usually the one accessed by customers).
`zip`	string	Optional	Vendor zip/postal code. Maximum 20 characters.

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.