{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/vendors","auth":"optional","examples":{"codes":[]},"method":"post","results":{"codes":[]},"settings":"","params":[]},"next":{"description":"","pages":[]},"title":"Create Vendor","type":"endpoint","slug":"create-vendor","excerpt":"","body":"The Create Vendor request enables you to set up a new vendor who will be associated with your marketplace.  The Create Vendor request is where you submit the vendors KYC information, their banking information, the agreed upon commission split and so on.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"* 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.\\n\\n* In addition, to be eligible for payout, the vendor must meet vendor verification requirements.\",\n  \"title\": \"Important: Vendor verification requirements\"\n}\n[/block]\n<a class=\"btn btn-success\" href=\"#section-api-explorer\" role=\"button\">Try it in the API Explorer</a>\n\n###Request Content\n`vendor` *container* &nbsp;&nbsp;&nbsp;<span style=\"color:#F37500\">**required**</span>, contains the following properties (see [vendor](doc:vendor)):\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`email` *string* &nbsp;&nbsp;&nbsp;<span style=\"color:#F37500\">**required**</span>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`name` *string* &nbsp;&nbsp;&nbsp; optional\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`first-name` *string* &nbsp;&nbsp;&nbsp; optional\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`last-name` *string* &nbsp;&nbsp;&nbsp; optional\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`phone` *string* &nbsp;&nbsp;&nbsp;optional\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`address` *string* &nbsp;&nbsp;&nbsp;optional\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`city` *string* &nbsp;&nbsp;optional\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`country` *string* &nbsp;&nbsp; <span style=\"color:#F37500\">**required**</span>\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`state` *string* &nbsp;&nbsp;optional &nbsp;&nbsp; applicable if country = US or CA (See [State and Province Codes](http://developers.bluesnap.com/docs/state-and-province-codes)).  \n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`zip` *string* &nbsp;&nbsp;optional\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`tax-id` *string* &nbsp;&nbsp;&nbsp;optional \n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`vat-id` *string* &nbsp;&nbsp;&nbsp;optional \n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`vendor-url` *string* &nbsp;&nbsp;&nbsp;optional \n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`default-payout-currency` *string* &nbsp;&nbsp;&nbsp;optional\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`frequency` *string* &nbsp;&nbsp;&nbsp;optional &nbsp;&nbsp;&nbsp;\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`delay` *integer* &nbsp;&nbsp;&nbsp;optional &nbsp;&nbsp;&nbsp;\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`vendor-principal` *container* &nbsp;&nbsp;&nbsp; optional; (see [vendor-principal](doc:vendor-principal))\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`vendor-agreement` *container* &nbsp;&nbsp;&nbsp; optional; (see [vendor-agreement](doc:vendor-agreement))\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`payout-info` *container* &nbsp;&nbsp;&nbsp;optional; (see [payout-info](doc:payout-info))\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`ipn-url` *string* &nbsp;&nbsp;&nbsp;optional \n\n###Response Details\nIf successful, the response HTTP status code is 201 Created.\nThe response header contains the `vendor-id`.\nThe `vendor-id` is required for all future transactions associated with this vendor.\n\n<hr>\n\n##Examples\n\n###Request Examples\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>vendor:::at:::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  <ipn-url>https://ipnaddress.com</ipn-url>\\n  <default-payout-currency>USD</default-payout-currency>\\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>[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>50</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\": \"Create Vendor - 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  <vendor-url>https://mycompany.com</vendor-url>\\n  <ipn-url>https://merchant-domain.com/ipn</ipn-url>\\n  <default-payout-currency>USD</default-payout-currency>\\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>[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>50</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      \"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  <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    <driver-license-number>561196411</driver-license-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  <payout-info>\\n    <payout-type>CHAPS</payout-type>\\n    <base-currency>GBP</base-currency>\\n    <name-on-account>Jane Shopper</name-on-account>\\n    <bank-account-type>CHECKING</bank-account-type>\\n    <bank-account-class>PERSONAL</bank-account-class>\\n    <bank-name>UniCredit</bank-name>\\n    <bank-id>123456</bank-id>\\n    <country>UK</country>\\n    <city>London</city>\\n    <address>Anzengrubergasse 14</address>\\n    <zip>8700</zip>\\n    <bank-account-id>12345678</bank-account-id>\\n    <minimal-payout-amount>25</minimal-payout-amount>\\n    <payment-reference>Payment for vendor 1234</payment-reference>\\n  </payout-info>\\n</vendor>'\",\n      \"language\": \"curl\",\n      \"name\": \"with 2 bank accounts\"\n    }\n  ]\n}\n[/block]\n###Response Examples\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"HTTP/ 1.1 201 Created\\nLocation: https://sandbox.bluesnap.com/services/2/vendors/19575974\",\n      \"language\": \"curl\",\n      \"name\": \"Create Vendor Response\"\n    }\n  ]\n}\n[/block]\n##Example Descriptions\n\n###Create Vendor: Individual\nThis example shows a Create Vendor request with all the information to fully board an individual vendor. To see the required information for payout, click [here](/docs/vendor-verification-requirements). \n\n###Create Vendor: Business\nThis example shows a Create Vendor request with all the information to fully board a business vendor. To see the required information for payout, click [here](/docs/vendor-verification-requirements). \n\n###Create Vendor: with 2 bank accounts\nThis example shows a Create Vendor request for an individual vendor with 2 bank accounts. The vendor's bank account details are included within separate `payout-info` containers (1 bank account per container). In this particular example, the vendor will be paid out in USD (via ACH) and EUR (via SEPA). Their default payout currency is USD. \n\nThe following conversion logic will apply: \n* Since the vendor's payout currencies are USD and EUR, if a sale occurs in either of these currencies, the sales funds will be paid out to the associated bank account. \n* Since the vendor's default payout currency is USD, if a sale occurs in a currency other than USD or EUR, the sales funds will be converted to USD and paid out to the associated bank account. \n\n<br>\n<a class=\"btn btn-primary\" href=\"#\" role=\"button\">Back to Top</a>\n\n##API Explorer\nTo test out a call, enter the request content below and then click **Try it!**\n\n**Tip**: Use the XML code below as a starting point. You can enter different parameters to see how your test scenario would work. *The request headers, including authorization, are already built in for you in this test area, so you should not include them here.*\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<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  <ipn-url>https://ipnaddress.com</ipn-url>\\n  <default-payout-currency>USD</default-payout-currency>\\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>[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>50</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\": \"xml\",\n      \"name\": \"XML\"\n    }\n  ]\n}\n[/block]","updates":[],"order":1,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5f43d7f192d43e01ff6f1123","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Marketplace","slug":"marketplace","order":12,"from_sync":false,"reference":false,"_id":"5f43d7f192d43e01ff6f1119","version":"5f43d7f192d43e01ff6f11c2","project":"57336fd5a6a9c40e00e13a0b","createdAt":"2016-11-23T18:27:07.992Z","__v":0},"user":"560d5913af97231900938124","parentDoc":null,"project":"57336fd5a6a9c40e00e13a0b","version":{"version":"8976-XML","version_clean":"8976.0.0-XML","codename":"3.35 Release","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5f43d7f192d43e01ff6f1110","5f43d7f192d43e01ff6f1111","5f43d7f192d43e01ff6f1112","5f43d7f192d43e01ff6f1113","5f43d7f192d43e01ff6f1114","5f43d7f192d43e01ff6f1115","5f43d7f192d43e01ff6f1116","5f43d7f192d43e01ff6f1117","5f43d7f192d43e01ff6f1118","5f43d7f192d43e01ff6f1119","5f43d7f192d43e01ff6f111a","5f43d7f192d43e01ff6f111b","5f43d7f192d43e01ff6f111c","5f43d7f192d43e01ff6f111d","5f43d7f192d43e01ff6f111e","5f43d7f192d43e01ff6f111f","5f43d7f192d43e01ff6f1120","5f43d7f192d43e01ff6f1121","5f47e410bd05ef0011069965"],"_id":"5f43d7f192d43e01ff6f11c2","project":"57336fd5a6a9c40e00e13a0b","__v":1,"forked_from":"5ed5174637c3c607440c0a3c","createdAt":"2018-04-24T15:24:22.608Z","releaseDate":"2018-04-24T15:24:22.608Z"},"createdAt":"2016-11-23T18:28:17.881Z","githubsync":"","__v":0}