vendor

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.
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. "+" character is not permitted.
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; 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.
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.
vendorPrincipal	container	optional	Vendor principal; refer to vendorPrincipal
payoutInfo	container	optional	Payout info; refer to payoutInfo.
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.
vendorAgreement	container	optional	Vendor agreement; refer to 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. Refer to verification.