{"_id":"5c6c238ff7d548003953558f","category":{"_id":"5c6c238ff7d5480039535560","version":"5c6c238ff7d54800395355a0","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-03-17T15:51:04.102Z","from_sync":false,"order":3,"slug":"marketplace","title":"Marketplace"},"project":"57336fd5a6a9c40e00e13a0b","parentDoc":null,"user":"560d5913af97231900938124","version":{"_id":"5c6c238ff7d54800395355a0","project":"57336fd5a6a9c40e00e13a0b","__v":1,"forked_from":"5beb278ac442ab0213f009cf","createdAt":"2018-04-23T14:36:48.535Z","releaseDate":"2018-04-23T14:36:48.535Z","categories":["5c6c238ff7d548003953555d","5c6c238ff7d548003953555e","5c6c238ff7d548003953555f","5c6c238ff7d5480039535560","5c6c238ff7d5480039535561","5c6c238ff7d5480039535562","5beb278ac442ab0213f00990","5c6c238ff7d5480039535563","5c3f542c12c4ac004bc51718","5c928dba4aa821001ae4f050"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"Main","version_clean":"8976.0.0-Basics","version":"8976-Basics"},"githubsync":"","__v":0,"metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-03-30T13:18:01.949Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":3,"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    \\\"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      \\t\\\"driverLicenseNumber\\\": \\\"561196411\\\",\\n        \\\"email\\\": \\\"individual.vendor@bluesnap.com\\\"\\n    },\\n    \\\"vendorAgreement\\\": {\\n        \\\"commissionPercent\\\": 30\\n    },\\n    \\\"payoutInfo\\\": [{\\n        \\\"payoutType\\\": \\\"ACH\\\",\\n        \\\"baseCurrency\\\": \\\"USD\\\",\\n        \\\"nameOnAccount\\\": \\\"vendor\\\",\\n        \\\"bankAccountType\\\": \\\"CHECKING\\\",\\n        \\\"bankAccountClass\\\": \\\"PERSONAL\\\",\\n        \\\"bankName\\\": \\\"Leumi\\\",\\n        \\\"bankId\\\": \\\"12445\\\",\\n        \\\"country\\\": \\\"US\\\",\\n        \\\"state\\\":\\\"MA\\\",\\n        \\\"city\\\": \\\"Juneau\\\",\\n        \\\"address\\\": \\\"1 bank address\\\",\\n        \\\"zip\\\": \\\"12345\\\",\\n        \\\"bankAccountId\\\": \\\"36628822\\\", \\n        \\\"minimalPayoutAmount\\\": 25\\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\\\": \\\"business.vendor@example.com\\\", \\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    \\\"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      \\t\\\"driverLicenseNumber\\\": \\\"561196411\\\",\\n        \\\"email\\\": \\\"principal.vendor@email.com\\\"\\n    }, \\n    \\\"vendorAgreement\\\": {\\n        \\\"commissionPercent\\\": \\\"30\\\"\\n      },\\n    \\\"payoutInfo\\\": [{\\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\\\": \\\"12445\\\",\\n        \\\"country\\\": \\\"US\\\",\\n        \\\"state\\\":\\\"MA\\\",\\n        \\\"city\\\": \\\"Boston\\\",\\n        \\\"address\\\": \\\"1 bank address\\\",\\n        \\\"zip\\\": \\\"12345\\\",\\n        \\\"bankAccountId\\\": \\\"36628822\\\", \\n        \\\"minimalPayoutAmount\\\": 25\\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>individual.vendor@example.com</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  <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    <driver-license-number>561196411</driver-license-number>\\n    <email>individual.vendor@bluesnap.com</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>12445</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  </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>business.vendor@example.com</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-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    <driver-license-number>561196411</driver-license-number>\\n    <email>principal.vendor@email.com</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>12445</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  </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 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>, value is last four digits of Social Security Number. Otherwise, value is the full National Identification Number.\\n        </li>\\n        <!-- driver's license number -->\\n        <li class=\\\"list-group-item\\\">\\n          <code>driverLicenseNumber</code> is required if vendor principal <code>country</code> value is <b>US</b>. \\n        </li>\\n        <!-- passport number -->\\n        <li class=\\\"list-group-item\\\">\\n          <code>passportNumber</code> is required if vendor principal <code>country</code> value is not <b>US</b>.\\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> is required. Value is vendor's commission percent for marketplace sales.  \\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, 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 -->\\n        <li class=\\\"list-group-item\\\">\\n          <code>bankId</code> is required. Value is bank ID number (i.e., Routing number).  \\n        </li>\\n        <!-- bank account ID -->\\n        <li class=\\\"list-group-item\\\">\\n          <code>bankAccountId</code> is required. Value is bank account number. \\n        </li>\\n        <!-- iban (if payout type is CHAPS or SEPA) -->\\n        <li class=\\\"list-group-item\\\">\\n          <code>iban</code> is required if <code>payoutType</code> value is <b>CHAPS</b> or <b>SEPA</b>. Value is International Bank Account Number. \\n        </li>\\n            <!-- swift-bic (if payout type is CHAPS or SEPA) -->\\n            <li class=\\\"list-group-item\\\">\\n              <code>swiftBic</code> is optional. Relevant if <code>payoutType</code> value is <b>CHAPS</b> or <b>SEPA</b>. Value is Bank Identifier Code. \\n            </li>\\n          <!-- minimal payout amount -->\\n \\t\\t\\t\\t\\t<li class=\\\"list-group-item\\\">\\n    \\t\\t\\t\\t<code>minimalPayoutAmount</code> is optional. We recommend setting this value to **25** or more to avoid payout delays and negative balances.\\n\\t\\t\\t\\t</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)**","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).","slug":"vendor-verification-requirements","type":"basic","title":"Vendor Verification Requirements"}

Vendor Verification Requirements

Learn about the vendor verification requirements for processing transactions and payout eligibility. If you have questions after reading this guide, check out our [FAQs page](https://support.bluesnap.com/docs/faqs-marketplace).

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": "individual.vendor@example.com",
    "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,
    "vendorPrincipal": {
        "firstName": "Joe",
        "lastName": "Smith",
        "address": "123 Main Street",
        "city": "Boston",
        "country": "US",
        "zip": "123456",
        "dob": "28-09-9999",
        "personalIdentificationNumber": "1234",
      	"driverLicenseNumber": "561196411",
        "email": "individual.vendor@bluesnap.com"
    },
    "vendorAgreement": {
        "commissionPercent": 30
    },
    "payoutInfo": [{
        "payoutType": "ACH",
        "baseCurrency": "USD",
        "nameOnAccount": "vendor",
        "bankAccountType": "CHECKING",
        "bankAccountClass": "PERSONAL",
        "bankName": "Leumi",
        "bankId": "12445",
        "country": "US",
        "state":"MA",
        "city": "Juneau",
        "address": "1 bank address",
        "zip": "12345",
        "bankAccountId": "36628822", 
        "minimalPayoutAmount": 25
    }]
}'
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": "business.vendor@example.com", 
    "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,
    "vendorPrincipal": {
        "firstName": "Joe",
        "lastName": "Smith",
        "address": "123 Main Street",
        "city": "Boston",
        "country": "US",
        "zip": "12345",
        "dob": "28-09-9999",
        "personalIdentificationNumber": "1234",
      	"driverLicenseNumber": "561196411",
        "email": "principal.vendor@email.com"
    }, 
    "vendorAgreement": {
        "commissionPercent": "30"
      },
    "payoutInfo": [{
        "payoutType": "ACH",
        "baseCurrency": "USD",
        "nameOnAccount": "name of vendor account",
        "bankAccountType": "CHECKING",
        "bankAccountClass": "CORPORATE",
        "bankName": "Bank of America",
        "bankId": "12445",
        "country": "US",
        "state":"MA",
        "city": "Boston",
        "address": "1 bank address",
        "zip": "12345",
        "bankAccountId": "36628822", 
        "minimalPayoutAmount": 25
      }]
}'
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>individual.vendor@example.com</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>
  <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>
    <driver-license-number>561196411</driver-license-number>
    <email>individual.vendor@bluesnap.com</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>12445</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>
  </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>business.vendor@example.com</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-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>
    <driver-license-number>561196411</driver-license-number>
    <email>principal.vendor@email.com</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>12445</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>
  </payout-info>
</vendor>'

Back to Top

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 or vatId 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 if country 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.
  • 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 principal country value is US, value is last four digits of Social Security Number. Otherwise, value is the full National Identification Number.
    • driverLicenseNumber is required if vendor principal country value is US.
    • passportNumber is required if vendor principal country value is not US.
    • email is required.
  • vendorAgreement is required. Contains vendor commission info. Show/hide properties
    • commissionPercent is required. Value is vendor's commission percent for marketplace sales.
  • payoutInfo is required. Contains vendor payout info. Show/hide properties
    • payoutType is required. Possible values: ACH, CHAPS, 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 bank country 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
    • bankId is required. Value is bank ID number (i.e., Routing number).
    • bankAccountId is required. Value is bank account number.
    • iban is required if payoutType value is CHAPS or SEPA. Value is International Bank Account Number.
    • swiftBic is optional. Relevant if payoutType value is CHAPS or SEPA. Value is Bank Identifier Code.
    • minimalPayoutAmount is optional. We recommend setting this value to **25** or more to avoid payout delays and negative balances.

*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).

Back to Top


Next: Updating Vendor Accounts

Now that you've learned about the vendor verification requirements for processing transactions and payout eligibility, move on to updating your vendor's account.

➔ Updating Vendor Accounts