{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","results":{"codes":[]},"settings":"","params":[]},"next":{"description":"","pages":[]},"title":"Vendor Verification Requirements","type":"basic","slug":"vendor-verification-requirements","excerpt":"Learn about the vendor verification requirements for processing transactions and payout eligibility.\nIf you have questions after reading this guide, check out our [FAQs page](https://support.bluesnap.com/docs/faqs-marketplace).","body":"In this section, we outline the necessary information for payout in the following ways:\n* [Full example](#section-full-example) — A complete example of creating a vendor account.\n* [Vendor properties](#section-vendor-properties) — The properties in a list format explaining when they are optional or required.\n[block:callout]\n{\n \"type\": \"danger\",\n \"title\": \"KYC Documentation\",\n \"body\": \"Make sure all the documentation you receive from your vendor and send to us is clear, legible, valid, and current.\"\n}\n[/block]\n###Full example\nBelow is an example of a [Create Vendor](/v8976-JSON/docs/create-vendor) request with sufficient information to fully board a vendor. In these code samples, we have a US vendor with a payout method of ACH/ECP. All properties are required unless specified as optional in the [Vendor properties](#section-vendor-properties) section below.\n[block:callout]\n{\n \"type\": \"info\",\n \"title\": \"Vendor information will vary\",\n \"body\": \"➔ Vendor accounts for individuals require information about the person, and vendor accounts for businesses require information about the business and a business representative.\\n\\n➔ Some information depends on the vendor's country, such as Payout Information and Personal Identification Number. \\n\\nReview the [Vendor properties](#section-vendor-properties) section below to understand how certain property values vary.\\n\\nVisit [Payout](/docs/payout#section-payoutinfo-examples) to see code samples of the different payout methods.\"\n}\n[/block]\n*Use these code samples as a template, and modify specific properties for your vendor.*\n[block:html]\n{\n \"html\": \"<ul class=\\\"nav nav-tabs\\\">\\n <li class=\\\"active\\\"><a data-toggle=\\\"tab\\\" href=\\\"#json\\\">JSON</a></li>\\n <li><a data-toggle=\\\"tab\\\" href=\\\"#xml\\\">XML</a></li>\\n</ul>\\n\\n<div class=\\\"tab-content\\\">\\n <div id=\\\"json\\\" class=\\\"tab-pane fade in active\\\">\"\n}\n[/block]\n\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"curl -v -X POST https://sandbox.bluesnap.com/services/2/vendors \\\\\\n-H 'Content-Type: application/json' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n{\\n \\\"email\\\": \\\"individual.vendor:::at:::example.com\\\",\\n \\\"firstName\\\": \\\"Joe\\\",\\n \\\"lastName\\\": \\\"Smith\\\",\\n \\\"phone\\\": \\\"1-123-456-7890\\\",\\n \\\"address\\\": \\\"123 Main Street\\\",\\n \\\"city\\\": \\\"Boston\\\",\\n \\\"country\\\": \\\"US\\\",\\n \\\"state\\\": \\\"MA\\\",\\n \\\"zip\\\": \\\"123456\\\",\\n \\\"defaultPayoutCurrency\\\": \\\"USD\\\",\\n \\\"frequency\\\": \\\"DAILY\\\",\\n \\\"delay\\\": 3,\\n \\\"ipnUrl\\\": \\\"https://merchant-domain.com/ipn\\\",\\n \\\"vendorPrincipal\\\": {\\n \\\"firstName\\\": \\\"Joe\\\",\\n \\\"lastName\\\": \\\"Smith\\\",\\n \\\"address\\\": \\\"123 Main Street\\\",\\n \\\"city\\\": \\\"Boston\\\",\\n \\\"country\\\": \\\"US\\\",\\n \\\"zip\\\": \\\"123456\\\",\\n \\\"dob\\\": \\\"28-09-9999\\\",\\n \\\"personalIdentificationNumber\\\": \\\"1234\\\",\\n \\\"email\\\": \\\"[email protected]\\\"\\n },\\n \\\"vendorAgreement\\\": {\\n \\\"commissionPercent\\\": 30\\n },\\n \\\"payoutInfo\\\": [\\n {\\n \\\"payoutType\\\": \\\"ACH\\\",\\n \\\"baseCurrency\\\": \\\"USD\\\",\\n \\\"nameOnAccount\\\": \\\"vendor\\\",\\n \\\"bankAccountType\\\": \\\"CHECKING\\\",\\n \\\"bankAccountClass\\\": \\\"PERSONAL\\\",\\n \\\"bankName\\\": \\\"Leumi\\\",\\n \\\"bankId\\\": \\\"123456789\\\",\\n \\\"country\\\": \\\"US\\\",\\n \\\"state\\\": \\\"MA\\\",\\n \\\"city\\\": \\\"Juneau\\\",\\n \\\"address\\\": \\\"1 bank address\\\",\\n \\\"zip\\\": \\\"12345\\\",\\n \\\"bankAccountId\\\": \\\"36628822\\\",\\n \\\"minimalPayoutAmount\\\": 25,\\n \\\"paymentReference\\\": \\\"Payment for vendor 1234\\\",\\n \\\"refundReserve\\\": 200\\n }\\n ]\\n}'\",\n \"language\": \"curl\",\n \"name\": \"Individual\"\n },\n {\n \"code\": \"curl -v -X POST https://sandbox.bluesnap.com/services/2/vendors \\\\\\n-H 'Content-Type: application/json' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n{\\n \\\"name\\\": \\\"Business ABC\\\",\\n \\\"email\\\": \\\"[email protected]\\\",\\n \\\"phone\\\": \\\"1-123-455-8765\\\",\\n \\\"address\\\": \\\"25 Business Avenue\\\",\\n \\\"city\\\": \\\"Boston\\\",\\n \\\"country\\\": \\\"US\\\",\\n \\\"state\\\": \\\"MA\\\",\\n \\\"zip\\\": \\\"123456\\\",\\n \\\"taxId\\\": \\\"123456789\\\",\\n \\\"defaultPayoutCurrency\\\": \\\"USD\\\",\\n \\\"frequency\\\": \\\"DAILY\\\",\\n \\\"delay\\\": 3,\\n \\\"ipnUrl\\\": \\\"https://merchant-domain.com/ipn\\\",\\n \\\"vendorUrl\\\": \\\"https://mycompany.com\\\",\\n \\\"vendorPrincipal\\\": {\\n \\\"firstName\\\": \\\"Joe\\\",\\n \\\"lastName\\\": \\\"Smith\\\",\\n \\\"address\\\": \\\"123 Main Street\\\",\\n \\\"city\\\": \\\"Boston\\\",\\n \\\"country\\\": \\\"US\\\",\\n \\\"zip\\\": \\\"12345\\\",\\n \\\"dob\\\": \\\"28-09-9999\\\",\\n \\\"personalIdentificationNumber\\\": \\\"1234\\\",\\n \\\"email\\\": \\\"[email protected]\\\"\\n },\\n \\\"vendorAgreement\\\": {\\n \\\"commissionPercent\\\": \\\"30\\\"\\n },\\n \\\"payoutInfo\\\": [\\n {\\n \\\"payoutType\\\": \\\"ACH\\\",\\n \\\"baseCurrency\\\": \\\"USD\\\",\\n \\\"nameOnAccount\\\": \\\"name of vendor account\\\",\\n \\\"bankAccountType\\\": \\\"CHECKING\\\",\\n \\\"bankAccountClass\\\": \\\"CORPORATE\\\",\\n \\\"bankName\\\": \\\"Bank of America\\\",\\n \\\"bankId\\\": \\\"123456789\\\",\\n \\\"country\\\": \\\"US\\\",\\n \\\"state\\\": \\\"MA\\\",\\n \\\"city\\\": \\\"Boston\\\",\\n \\\"address\\\": \\\"1 bank address\\\",\\n \\\"zip\\\": \\\"12345\\\",\\n \\\"bankAccountId\\\": \\\"36628822\\\",\\n \\\"minimalPayoutAmount\\\": 25,\\n \\\"paymentReference\\\": \\\"Payment for vendor 1234\\\",\\n \\\"refundReserve\\\": 200\\n }\\n ]\\n}'\",\n \"language\": \"curl\",\n \"name\": \"Business \"\n }\n ]\n}\n[/block]\n\n[block:html]\n{\n \"html\": \"\\t</div>\\n<div id=\\\"xml\\\" class=\\\"tab-pane fade\\\">\"\n}\n[/block]\n\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"curl -v -X POST https://sandbox.bluesnap.com/services/2/vendors \\\\\\n-H 'Content-Type: application/xml' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n<vendor xmlns=\\\"http://ws.plimus.com\\\">\\n <email>[email protected]</email>\\n <first-name>Joe</first-name>\\n <last-name>Smith</last-name>\\n <phone>1-123-456-7890</phone>\\n <address>123 Main Street</address>\\n <city>Boston</city>\\n <country>US</country>\\n <state>MA</state>\\n <zip>123456</zip>\\n <default-payout-currency>USD</default-payout-currency>\\n <frequency>DAILY</frequency>\\n <delay>3</delay>\\n <ipn-url>https://merchant-domain.com/ipn</ipn-url>\\n <vendor-principal>\\n <first-name>Joe</first-name>\\n <last-name>Smith</last-name>\\n <address>123 Main Street</address>\\n <city>Boston</city>\\n <country>US</country>\\n <zip>123456</zip>\\n <dob>28-09-9999</dob>\\n <personal-identification-number>1234</personal-identification-number>\\n <email>[email protected]</email>\\n </vendor-principal>\\n <vendor-agreement>\\n <commission-percent>30</commission-percent>\\n </vendor-agreement>\\n <payout-info>\\n <payout-type>ACH</payout-type>\\n <base-currency>USD</base-currency>\\n <name-on-account>vendor</name-on-account>\\n <bank-account-type>CHECKING</bank-account-type>\\n <bank-account-class>PERSONAL</bank-account-class>\\n <bank-name>Leumi</bank-name>\\n <bank-id>123456789</bank-id>\\n <country>US</country>\\n <state>MA</state>\\n <city>Juneau</city>\\n <address>1 bank address</address>\\n <zip>12345</zip>\\n <bank-account-id>36628822</bank-account-id>\\n <minimal-payout-amount>25</minimal-payout-amount>\\n <payment-reference>Payment for vendor 1234</payment-reference>\\n <refund-reserve>200</refund-reserve>\\n </payout-info>\\n</vendor>'\",\n \"language\": \"curl\",\n \"name\": \"Individual \"\n },\n {\n \"code\": \"curl -v -X POST https://sandbox.bluesnap.com/services/2/vendors \\\\\\n-H 'Content-Type: application/xml' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n<vendor xmlns=\\\"http://ws.plimus.com\\\">\\n <name>Business ABC</name>\\n <email>[email protected]</email>\\n <phone>1-123-455-8765</phone>\\n <address>25 Business Avenue</address>\\n <city>Boston</city>\\n <country>US</country>\\n <state>MA</state>\\n <zip>123456</zip>\\n <tax-id>123456789</tax-id>\\n <default-payout-currency>USD</default-payout-currency>\\n <frequency>DAILY</frequency>\\n <delay>3</delay>\\n <vendor-url>https://mycompany.com</vendor-url>\\n <ipn-url>https://merchant-domain.com/ipn</ipn-url>\\n <vendor-principal>\\n <first-name>Joe</first-name>\\n <last-name>Smith</last-name>\\n <address>123 Main Street</address>\\n <city>Boston</city>\\n <country>US</country>\\n <zip>12345</zip>\\n <dob>28-09-9999</dob>\\n <personal-identification-number>1234</personal-identification-number>\\n <email>[email protected]</email>\\n </vendor-principal>\\n <vendor-agreement>\\n <commission-percent>30</commission-percent>\\n </vendor-agreement>\\n <payout-info>\\n <payout-type>ACH</payout-type>\\n <base-currency>USD</base-currency>\\n <name-on-account>name of vendor account</name-on-account>\\n <bank-account-type>CHECKING</bank-account-type>\\n <bank-account-class>CORPORATE</bank-account-class>\\n <bank-name>Bank of America</bank-name>\\n <bank-id>123456789</bank-id>\\n <country>US</country>\\n <state>MA</state>\\n <city>Boston</city>\\n <address>1 bank address</address>\\n <zip>12345</zip>\\n <bank-account-id>36628822</bank-account-id>\\n <minimal-payout-amount>25</minimal-payout-amount>\\n <payment-reference>Payment for vendor 1234</payment-reference>\\n <refund-reserve>200</refund-reserve>\\n </payout-info>\\n</vendor>'\",\n \"language\": \"curl\",\n \"name\": \"Business \"\n }\n ]\n}\n[/block]\n\n[block:html]\n{\n \"html\": \"\\t</div>\\n</div>\"\n}\n[/block]\n<a class=\"btn btn-primary\" href=\"#\" role=\"button\">Back to Top</a>\n\n### Vendor properties \nThis section lists the vendor properties for payout to businesses and individuals. More information on any of the below properties can be found in our [API Reference](/v8976-JSON/docs/vendorinfo). \n[block:html]\n{\n \"html\": \" <style>\\n ul.custom-3 > li {\\n /*background-color: rgba(254, 246, 188, 0.1);*/\\n border-left: 5px solid #dcdcdc;\\n }\\n</style>\\n\\n<ul class=\\\"list-group\\\">\\n <!-- first name -->\\n <li class=\\\"list-group-item\\\">\\n <code>firstName</code> is required for individuals. \\n </li>\\n <!-- last name -->\\n <li class=\\\"list-group-item\\\">\\n <code>lastName</code> is required for individuals.\\n </li>\\n <!-- name -->\\n <li class=\\\"list-group-item\\\">\\n <code>name</code> is required for businesses. Value is vendor's business name.\\n </li>\\n <!-- tax ID or VAT ID -->\\n <li class=\\\"list-group-item\\\">\\n Either <code>taxId</code> or <code>vatId</code> is required for businesses (only one per request). \\n </li>\\n <!-- email -->\\n <li class=\\\"list-group-item\\\">\\n <code>email</code> is required. \\n </li>\\n<!-- phone --> \\n <li class=\\\"list-group-item\\\">\\n <code>phone</code> is required. \\n </li>\\n <!-- country -->\\n <li class=\\\"list-group-item\\\"> \\n <code>country</code> is required. Value is vendor's <a href=\\\"/docs/country-codes\\\">country code</a>. \\n </li>\\n <!-- state (if country is US or CA) -->\\n <li class=\\\"list-group-item\\\">\\n <code>state</code> is required if <code>country</code> value is <b>US</b> or <b>CA</b>. \\n</li>\\n <!-- city -->\\n <li class=\\\"list-group-item\\\">\\n <code>city</code> is required.\\n </li>\\n <!-- zip -->\\n <li class=\\\"list-group-item\\\">\\n <code>zip</code> is required. \\n </li>\\n <!-- default payout currency -->\\n <li class=\\\"list-group-item\\\">\\n <code>defaultPayoutCurrency</code>* is optional. Default value is <b>USD</b>. 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 </li>\\n <!-- frequency -->\\n <li class=\\\"list-group-item\\\">\\n <code>frequency</code> is optional. Default value is Marketplace Merchant's payout frequency. \\n </li>\\n <!-- delay -->\\n <li class=\\\"list-group-item\\\">\\n <code>delay</code> is optional. Default value is Marketplace Merchant's payout delay. \\n </li>\\n <!-- Vendor URL -->\\n <li class=\\\"list-group-item\\\">\\n <code>vendorUrl</code> is optional. Value is the main, customer-facing URL of the vendor's business. \\n </li>\\n <!-- IPN URL -->\\n <li class=\\\"list-group-item\\\">\\n <code>ipnUrl</code> is optional. Value is the URL where the <a href=\\\"https://support.bluesnap.com/docs/ipns-name-reference#PAYOUT\\\">Payout IPN</a> should be sent. \\n </li>\\n <!-- vendor principal -->\\n <li class=\\\"list-group-item\\\">\\n <code>vendorPrincipal</code> is required. Contains vendor principal owner info.\\n <a data-toggle=\\\"collapse\\\" href=\\\"#collapse1\\\">Show/hide properties</a>\\n <div id=\\\"collapse1\\\" class=\\\"panel-collapse collapse\\\" style=\\\"margin-top:6px;\\\">\\n <ul class=\\\"list-group custom-3\\\" style=\\\"margin-bottom:4px\\\">\\n <!-- first name -->\\n <li class=\\\"list-group-item\\\">\\n <code>firstName</code> is required. \\n </li>\\n <!-- last name -->\\n <li class=\\\"list-group-item\\\">\\n <code>lastName</code> is required. \\n </li>\\n <!-- address -->\\n <li class=\\\"list-group-item\\\">\\n <code>address</code> is required. \\n </li>\\n <!-- country -->\\n <li class=\\\"list-group-item\\\">\\n <code>country</code> is required. Value is vendor principal's <a href=\\\"/docs/country-codes\\\">country code</a>. \\n </li>\\n <!-- city -->\\n <li class=\\\"list-group-item\\\">\\n <code>city</code> is required. \\n </li>\\n <!-- zip -->\\n <li class=\\\"list-group-item\\\">\\n <code>zip</code> is required. \\n </li>\\n <!-- dob -->\\n <li class=\\\"list-group-item\\\">\\n <code>dob</code> is required. Value is vendor principal's date of birth.\\n </li>\\n <!-- personal identification number -->\\n <li class=\\\"list-group-item\\\">\\n <code>personalIdentificationNumber</code> is required if vendor principal <code>country</code> value is <b>US</b>; in this case, the value is the last four digits of Social Security Number, and no other ID field (<code>driverLicenseNumber</code> or <code>passportNumber</code>) is required. Otherwise, value is the full National Identification Number. <b>Note</b>: only one of ID fields personalIdentificationNumber, driversLicenseNumber or passportNumber is required.\\n </li>\\n <!-- driver's license number -->\\n <li class=\\\"list-group-item\\\">\\n <code>driverLicenseNumber</code> is only required if no other ID fields, such as <code>personalIdentificationNumber</code> or <code>passportNumber</code>, have been provided. \\n </li>\\n <!-- passport number -->\\n <li class=\\\"list-group-item\\\">\\n <code>passportNumber</code> is only required if no other ID fields, such as <code>personalIdentificationNumber</code> or <code>driverLicenseNumber</code>, have been provided.\\n </li>\\n <!-- email -->\\n <li class=\\\"list-group-item\\\">\\n <code>email</code> is required.\\n </li>\\n </ul>\\n </div>\\n</li>\\n <!-- vendor agreement -->\\n <li class=\\\"list-group-item\\\">\\n <code>vendorAgreement</code> is required. Contains vendor commission info.\\n <a data-toggle=\\\"collapse\\\" href=\\\"#collapse2\\\">Show/hide properties</a>\\n <div id=\\\"collapse2\\\" class=\\\"panel-collapse collapse\\\" style=\\\"margin-top:6px\\\">\\n <ul class=\\\"list-group custom-3\\\" style=\\\"margin-bottom:4px\\\">\\n <!-- commission percent -->\\n <li class=\\\"list-group-item\\\">\\n <code>commissionPercent</code> The value is vendor's commission percent for marketplace sales. Either percent or amount must be set.\\n <!-- commission amount -->\\n <li class=\\\"list-group-item\\\">\\n <code>commissionAmount</code> The value is vendor's commission amount for marketplace sales. Either percent or amount must be set.\\n </li>\\n </ul>\\n </div>\\n</li>\\n <!-- payout info -->\\n <li class=\\\"list-group-item\\\">\\n <code>payoutInfo</code> is required. Contains vendor payout info. \\n <a data-toggle=\\\"collapse\\\" href=\\\"#collapse3\\\">Show/hide properties</a>\\n <div id=\\\"collapse3\\\" class=\\\"panel-collapse collapse\\\" style=\\\"margin-top:6px\\\">\\n <ul class=\\\"list-group custom-3\\\" style=\\\"margin-bottom:4px\\\">\\n <!-- payout type --> \\n <li class=\\\"list-group-item\\\">\\n <code>payoutType</code> is required. Possible values: ACH, CHAPS, FAST, SEPA, WIRE. \\n </li>\\n <!-- base currency -->\\n <li class=\\\"list-group-item\\\">\\n <code>baseCurrency</code> is required. Value is payout currency for bank account.\\n </li>\\n <!-- bank name -->\\n <li class=\\\"list-group-item\\\">\\n <code>bankName</code> is required. \\n </li>\\n <!-- address -->\\n <li class=\\\"list-group-item\\\">\\n <code>address</code> is required. Value is street address of vendor's bank. \\n </li>\\n <!-- country -->\\n <li class=\\\"list-group-item\\\">\\n <code>country</code> is required. Value is <a href=\\\"/docs/country-codes\\\">country code</a> of vendor's bank. \\n </li>\\n <!-- state (if bank country is US or CA) -->\\n <li class=\\\"list-group-item\\\">\\n <code>state</code> is required if bank <code>country</code> value is <b>US</b> or <b>CA</b>. \\n </li>\\n <!-- city -->\\n <li class=\\\"list-group-item\\\">\\n <code>city</code> is required. \\n </li>\\n <!-- zip -->\\n <li class=\\\"list-group-item\\\">\\n <code>zip</code> is required. \\n </li>\\n <!-- name on account -->\\n <li class=\\\"list-group-item\\\">\\n <code>nameOnAccount</code> is required. \\n </li>\\n <!-- bank account class -->\\n <li class=\\\"list-group-item\\\">\\n <code>bankAccountClass</code> is required. Possible values: PERSONAL, CORPORATE, INTERNATIONAL\\n </li>\\n <!-- bank account type -->\\n <li class=\\\"list-group-item\\\">\\n <code>bankAccountType</code> is required. Possible values: CHECKING, SAVINGS\\n </li>\\n <!-- bank ID or Swift BIC-->\\n <li class=\\\"list-group-item\\\">\\n Either <code>bankId</code> or <code>swiftBic</code> is required, but not both.\\n </li>\\n <!-- bank account ID or IBAN -->\\n <li class=\\\"list-group-item\\\">\\n Either <code>bankAccountId</code> or <code>iban</code> is\\n required, but not both.\\n </li>\\n <!-- minimal payout amount -->\\n \\t\\t\\t\\t\\t<li class=\\\"list-group-item\\\">\\n <code>minimalPayoutAmount</code> is optional. We recommend setting this value to <b>25</b> or more to avoid payout delays and negative balances.\\n\\t\\t\\t\\t</li>\\n <!-- payment reference -->\\n <li class=\\\"list-group-item\\\">\\n <code>paymentReference</code> is optional. Value is the reference text that appears on the vendor's bank statement when they are paid out. \\n </li>\\n <!-- refund reserve -->\\n <li class=\\\"list-group-item\\\">\\n <code>refundReserve</code> is optional. We recommend setting a value for this property to ensure your vendor has enough funds available for refunds. \\n </li>\\n </ul>\\n </div>\\n</li>\\n \\n</ul>\"\n}\n[/block]\n*Your vendor's `defaultPayoutCurrency` must have an associated bank account defined within `payoutInfo`.\n\n[block:html]\n{\n \"html\": \"\\t</div>\\n</div>\"\n}\n[/block]\n\n[block:callout]\n{\n \"type\": \"warning\",\n \"title\": \"Missing vendor information\",\n \"body\": \"* BlueSnap may ask for additional information if it is needed for vendor verification (e.g., driver's license or passport image).\\n* Make sure all the documentation you receive from your vendor and send to us is clear, legible, valid, and current.\"\n}\n[/block]\n\n[block:callout]\n{\n \"type\": \"success\",\n \"title\": \"Staying informed of vendor status changes\",\n \"body\": \"Any changes to your vendor’s status is sent to you using the Vendor Status Changed [webhook](/docs/vendor-onboarding#section-staying-informed-with-webhooks). \\n\\nIf your vendor's payout status is **Approved**, then your vendor is eligible for payout (see [Vendor Onboarding](/docs/vendor-onboarding#section-understanding-your-vendor-s-statuses)).\"\n}\n[/block]\n<a class=\"btn btn-primary\" href=\"#\" role=\"button\">Back to Top</a>\n\n<hr>\n\n##Next: Updating Vendor Accounts\nNow that you've learned about the vendor verification requirements for processing transactions and payout eligibility, move on to updating your vendor's account. \n\n**[➔ Updating Vendor Accounts](/docs/updating-vendor-accounts)**","updates":[],"order":5,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"62178c1e445ec2009631ec1b","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Marketplace/Split Payments","slug":"marketplace","order":4,"from_sync":false,"reference":false,"_id":"62178c1e445ec2009631ebee","version":"62178c1e445ec2009631ec4d","project":"57336fd5a6a9c40e00e13a0b","createdAt":"2017-03-17T15:51:04.102Z","__v":1},"project":"57336fd5a6a9c40e00e13a0b","parentDoc":null,"user":"560d5913af97231900938124","version":{"version":"8976-Embedded-Payments","version_clean":"8976.0.0-Embedded-Payments","codename":"3.40 Release","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["62178c1e445ec2009631ebeb","62178c1e445ec2009631ebec","62178c1e445ec2009631ebed","62178c1e445ec2009631ebee","62178c1e445ec2009631ebef","62178c1e445ec2009631ebf0","5beb278ac442ab0213f00990","62178c1e445ec2009631ebf1","5c3f542c12c4ac004bc51718","62178c1e445ec2009631ebf2","5df806ccecebde0059f17225","5dfa8a8f340c2b007418eb8a","62178c1e445ec2009631ebf3","5e597199fd2b0200117c2c1c"],"_id":"62178c1e445ec2009631ec4d","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"6183ed028202aa00161024e9","createdAt":"2018-04-23T14:36:48.535Z","releaseDate":"2018-04-23T14:36:48.535Z"},"createdAt":"2017-03-30T13:18:01.949Z","githubsync":"","__v":0}
Vendor Verification Requirements
In this section, we outline the necessary information for payout in the following ways:
- Full example — A complete example of creating a vendor account.
- Vendor properties — The properties in a list format explaining when they are optional or required.
KYC Documentation
Make sure all the documentation you receive from your vendor and send to us is clear, legible, valid, and current.
Full example
Below is an example of a Create Vendor request with sufficient information to fully board a vendor. In these code samples, we have a US vendor with a payout method of ACH/ECP. All properties are required unless specified as optional in the Vendor properties section below.
Vendor information will vary
➔ Vendor accounts for individuals require information about the person, and vendor accounts for businesses require information about the business and a business representative.
➔ Some information depends on the vendor's country, such as Payout Information and Personal Identification Number.
Review the Vendor properties section below to understand how certain property values vary.
Visit Payout to see code samples of the different payout methods.
Use these code samples as a template, and modify specific properties for your vendor.
curl -v -X POST https://sandbox.bluesnap.com/services/2/vendors \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
"email": "[email protected]",
"firstName": "Joe",
"lastName": "Smith",
"phone": "1-123-456-7890",
"address": "123 Main Street",
"city": "Boston",
"country": "US",
"state": "MA",
"zip": "123456",
"defaultPayoutCurrency": "USD",
"frequency": "DAILY",
"delay": 3,
"ipnUrl": "https://merchant-domain.com/ipn",
"vendorPrincipal": {
"firstName": "Joe",
"lastName": "Smith",
"address": "123 Main Street",
"city": "Boston",
"country": "US",
"zip": "123456",
"dob": "28-09-9999",
"personalIdentificationNumber": "1234",
"email": "[email protected]"
},
"vendorAgreement": {
"commissionPercent": 30
},
"payoutInfo": [
{
"payoutType": "ACH",
"baseCurrency": "USD",
"nameOnAccount": "vendor",
"bankAccountType": "CHECKING",
"bankAccountClass": "PERSONAL",
"bankName": "Leumi",
"bankId": "123456789",
"country": "US",
"state": "MA",
"city": "Juneau",
"address": "1 bank address",
"zip": "12345",
"bankAccountId": "36628822",
"minimalPayoutAmount": 25,
"paymentReference": "Payment for vendor 1234",
"refundReserve": 200
}
]
}'
curl -v -X POST https://sandbox.bluesnap.com/services/2/vendors \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
"name": "Business ABC",
"email": "[email protected]",
"phone": "1-123-455-8765",
"address": "25 Business Avenue",
"city": "Boston",
"country": "US",
"state": "MA",
"zip": "123456",
"taxId": "123456789",
"defaultPayoutCurrency": "USD",
"frequency": "DAILY",
"delay": 3,
"ipnUrl": "https://merchant-domain.com/ipn",
"vendorUrl": "https://mycompany.com",
"vendorPrincipal": {
"firstName": "Joe",
"lastName": "Smith",
"address": "123 Main Street",
"city": "Boston",
"country": "US",
"zip": "12345",
"dob": "28-09-9999",
"personalIdentificationNumber": "1234",
"email": "[email protected]"
},
"vendorAgreement": {
"commissionPercent": "30"
},
"payoutInfo": [
{
"payoutType": "ACH",
"baseCurrency": "USD",
"nameOnAccount": "name of vendor account",
"bankAccountType": "CHECKING",
"bankAccountClass": "CORPORATE",
"bankName": "Bank of America",
"bankId": "123456789",
"country": "US",
"state": "MA",
"city": "Boston",
"address": "1 bank address",
"zip": "12345",
"bankAccountId": "36628822",
"minimalPayoutAmount": 25,
"paymentReference": "Payment for vendor 1234",
"refundReserve": 200
}
]
}'
curl -v -X POST https://sandbox.bluesnap.com/services/2/vendors \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
<vendor xmlns="http://ws.plimus.com">
<email>[email protected]</email>
<first-name>Joe</first-name>
<last-name>Smith</last-name>
<phone>1-123-456-7890</phone>
<address>123 Main Street</address>
<city>Boston</city>
<country>US</country>
<state>MA</state>
<zip>123456</zip>
<default-payout-currency>USD</default-payout-currency>
<frequency>DAILY</frequency>
<delay>3</delay>
<ipn-url>https://merchant-domain.com/ipn</ipn-url>
<vendor-principal>
<first-name>Joe</first-name>
<last-name>Smith</last-name>
<address>123 Main Street</address>
<city>Boston</city>
<country>US</country>
<zip>123456</zip>
<dob>28-09-9999</dob>
<personal-identification-number>1234</personal-identification-number>
<email>[email protected]</email>
</vendor-principal>
<vendor-agreement>
<commission-percent>30</commission-percent>
</vendor-agreement>
<payout-info>
<payout-type>ACH</payout-type>
<base-currency>USD</base-currency>
<name-on-account>vendor</name-on-account>
<bank-account-type>CHECKING</bank-account-type>
<bank-account-class>PERSONAL</bank-account-class>
<bank-name>Leumi</bank-name>
<bank-id>123456789</bank-id>
<country>US</country>
<state>MA</state>
<city>Juneau</city>
<address>1 bank address</address>
<zip>12345</zip>
<bank-account-id>36628822</bank-account-id>
<minimal-payout-amount>25</minimal-payout-amount>
<payment-reference>Payment for vendor 1234</payment-reference>
<refund-reserve>200</refund-reserve>
</payout-info>
</vendor>'
curl -v -X POST https://sandbox.bluesnap.com/services/2/vendors \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
<vendor xmlns="http://ws.plimus.com">
<name>Business ABC</name>
<email>[email protected]</email>
<phone>1-123-455-8765</phone>
<address>25 Business Avenue</address>
<city>Boston</city>
<country>US</country>
<state>MA</state>
<zip>123456</zip>
<tax-id>123456789</tax-id>
<default-payout-currency>USD</default-payout-currency>
<frequency>DAILY</frequency>
<delay>3</delay>
<vendor-url>https://mycompany.com</vendor-url>
<ipn-url>https://merchant-domain.com/ipn</ipn-url>
<vendor-principal>
<first-name>Joe</first-name>
<last-name>Smith</last-name>
<address>123 Main Street</address>
<city>Boston</city>
<country>US</country>
<zip>12345</zip>
<dob>28-09-9999</dob>
<personal-identification-number>1234</personal-identification-number>
<email>[email protected]</email>
</vendor-principal>
<vendor-agreement>
<commission-percent>30</commission-percent>
</vendor-agreement>
<payout-info>
<payout-type>ACH</payout-type>
<base-currency>USD</base-currency>
<name-on-account>name of vendor account</name-on-account>
<bank-account-type>CHECKING</bank-account-type>
<bank-account-class>CORPORATE</bank-account-class>
<bank-name>Bank of America</bank-name>
<bank-id>123456789</bank-id>
<country>US</country>
<state>MA</state>
<city>Boston</city>
<address>1 bank address</address>
<zip>12345</zip>
<bank-account-id>36628822</bank-account-id>
<minimal-payout-amount>25</minimal-payout-amount>
<payment-reference>Payment for vendor 1234</payment-reference>
<refund-reserve>200</refund-reserve>
</payout-info>
</vendor>'
Vendor properties
This section lists the vendor properties for payout to businesses and individuals. More information on any of the below properties can be found in our API Reference.
-
firstName
is required for individuals. -
lastName
is required for individuals. -
name
is required for businesses. Value is vendor's business name. -
Either
taxId
orvatId
is required for businesses (only one per request). -
email
is required. -
phone
is required. -
country
is required. Value is vendor's country code. -
state
is required ifcountry
value is US or CA. -
city
is required. -
zip
is required. -
defaultPayoutCurrency
* is optional. Default value is USD. If a sale occurs in a currency for which there is not an associated bank account, sale funds will be converted to this currency. -
frequency
is optional. Default value is Marketplace Merchant's payout frequency. -
delay
is optional. Default value is Marketplace Merchant's payout delay. -
vendorUrl
is optional. Value is the main, customer-facing URL of the vendor's business. -
ipnUrl
is optional. Value is the URL where the Payout IPN should be sent. -
vendorPrincipal
is required. Contains vendor principal owner info. Show/hide properties-
firstName
is required. -
lastName
is required. -
address
is required. -
country
is required. Value is vendor principal's country code. -
city
is required. -
zip
is required. -
dob
is required. Value is vendor principal's date of birth. -
personalIdentificationNumber
is required if vendor principalcountry
value is US; in this case, the value is the last four digits of Social Security Number, and no other ID field (driverLicenseNumber
orpassportNumber
) is required. Otherwise, value is the full National Identification Number. Note: only one of ID fields personalIdentificationNumber, driversLicenseNumber or passportNumber is required. -
driverLicenseNumber
is only required if no other ID fields, such aspersonalIdentificationNumber
orpassportNumber
, have been provided. -
passportNumber
is only required if no other ID fields, such aspersonalIdentificationNumber
ordriverLicenseNumber
, have been provided. -
email
is required.
-
-
vendorAgreement
is required. Contains vendor commission info. Show/hide properties-
commissionPercent
The value is vendor's commission percent for marketplace sales. Either percent or amount must be set. -
commissionAmount
The value is vendor's commission amount for marketplace sales. Either percent or amount must be set.
-
-
payoutInfo
is required. Contains vendor payout info. Show/hide properties-
payoutType
is required. Possible values: ACH, CHAPS, FAST, SEPA, WIRE. -
baseCurrency
is required. Value is payout currency for bank account. -
bankName
is required. -
address
is required. Value is street address of vendor's bank. -
country
is required. Value is country code of vendor's bank. -
state
is required if bankcountry
value is US or CA. -
city
is required. -
zip
is required. -
nameOnAccount
is required. -
bankAccountClass
is required. Possible values: PERSONAL, CORPORATE, INTERNATIONAL -
bankAccountType
is required. Possible values: CHECKING, SAVINGS -
Either
bankId
orswiftBic
is required, but not both. -
Either
bankAccountId
oriban
is required, but not both. -
minimalPayoutAmount
is optional. We recommend setting this value to 25 or more to avoid payout delays and negative balances. -
paymentReference
is optional. Value is the reference text that appears on the vendor's bank statement when they are paid out. -
refundReserve
is optional. We recommend setting a value for this property to ensure your vendor has enough funds available for refunds.
-
*Your vendor's defaultPayoutCurrency
must have an associated bank account defined within payoutInfo
.
Missing vendor information
- BlueSnap may ask for additional information if it is needed for vendor verification (e.g., driver's license or passport image).
- Make sure all the documentation you receive from your vendor and send to us is clear, legible, valid, and current.
Staying informed of vendor status changes
Any changes to your vendor’s status is sent to you using the Vendor Status Changed webhook.
If your vendor's payout status is Approved, then your vendor is eligible for payout (see Vendor Onboarding).