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 NameTypeRequiredDescription
namestringoptionalVendor / Business name. Maximum 100 characters.
firstNamestringoptionalVendor first name. Maximum 40 characters.
lastNamestringoptionalVendor last name. Maximum 40 characters.
emailstringrequiredVendor email. Maximum 150 characters. "+" character is not permitted.
phonestringoptionalVendor phone. Maximum 30 characters.
addressstringoptionalVendor address. Maximum 60 characters.
citystringoptionalVendor city. Maximum 40 characters.
countrystringrequiredVendor country; refer to Country codes
Applicable if country = US or CA
Vendor state/province; refer to State and Province Codes
zipstringoptionalVendor zip/postal code. Maximum 20 characters.
taxIdstringoptional; do not include if sending vatIdThe company’s business ID number. For example, EIN in the US, Business Number in Canada, Company Number in the UK, etc. Maximum 18 characters.
vatIdstringoptional; do not include if sending taxIdThe company’s VAT number. Maximum 18 characters.
vendorUrlstringoptionalThe main URL for the vendor's business (usually the one accessed by customers).
defaultPayoutCurrencystringoptionalVendor'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.
frequencystringoptionalVendor payout frequency. Default value is Marketplace Merchant's payout frequency.

Possible values:

Note: Your vendor's payout settings cannot result in quicker payout than your own.
delayintegeroptionalVendor 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.
vendorPrincipalcontaineroptionalVendor principal; refer to vendorPrincipal
payoutInfocontaineroptionalPayout info; refer to payoutInfo.
ipnUrlstringoptionalThis determines where the Payout IPN is sent. Enter the merchant's IPN URL if the Payout IPN should be sent to the merchant.
vendorAgreementcontaineroptionalVendor agreement; refer to vendorAgreement


Response contains request properties plus these additions:

Property NameTypeDescription
vendorIdintegerID assigned to vendor. To be used on all transactions involving this vendor
verificationobjectIncludes information about vendor payout and processing statuses. Refer to verification.