{"_id":"5c6c2407b8d4b2000e72d992","category":{"_id":"5c6c2407b8d4b2000e72d98a","version":"5c6c2407b8d4b2000e72da25","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-11-23T18:27:07.992Z","from_sync":false,"order":9,"slug":"marketplace","title":"Marketplace"},"user":"560d5913af97231900938124","parentDoc":null,"project":"57336fd5a6a9c40e00e13a0b","version":{"_id":"5c6c2407b8d4b2000e72da25","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5beec5a5f95d82011c6f3714","createdAt":"2018-04-24T15:24:22.608Z","releaseDate":"2018-04-24T15:24:22.608Z","categories":["5c6c2407b8d4b2000e72d981","5c6c2407b8d4b2000e72d982","5c6c2407b8d4b2000e72d983","5c6c2407b8d4b2000e72d984","5c6c2407b8d4b2000e72d985","5c6c2407b8d4b2000e72d986","5c6c2407b8d4b2000e72d987","5c6c2407b8d4b2000e72d988","5c6c2407b8d4b2000e72d989","5c6c2407b8d4b2000e72d98a","5c6c2407b8d4b2000e72d98b","5c6c2407b8d4b2000e72d98c","5c6c2407b8d4b2000e72d98d","5c6c2407b8d4b2000e72d98e","5c6c2407b8d4b2000e72d98f","5c6c2407b8d4b2000e72d990"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"Main","version_clean":"8976.0.0-XML","version":"8976-XML"},"githubsync":"","__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-11-23T18:28:17.881Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"post","results":{"codes":[]},"settings":"","auth":"optional","params":[],"url":"/vendors"},"isReference":false,"order":1,"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\": \"To be eligible for payout, the vendor must meet [vendor verification requirements](/docs/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* <span style=\"color:#F37500\">**required**</span>, contains the following properties (see [vendor](doc:vendor)):\n `email` *string* <span style=\"color:#F37500\">**required**</span> \n `name` *string* optional\n `first-name` *string* optional\n `last-name` *string* optional\n `phone` *string* optional\n `address` *string* optional\n `city` *string* optional\n `country` *string* <span style=\"color:#F37500\">**required**</span>\n `state` *string* optional applicable if country = US or CA (See [State and Province Codes](http://developers.bluesnap.com/docs/state-and-province-codes)). \n `zip` *string* optional\n `tax-id` *string* optional \n `vat-id` *string* optional \n `default-payout-currency` *string* optional\n `frequency` *string* optional \n `delay` *integer* optional \n `vendor-principal` *container* optional; (see [vendor-principal](doc:vendor-principal))\n `vendor-agreement` *container* optional; (see [vendor-agreement](doc:vendor-agreement))\n `payout-info` *container* optional; (see [payout-info](doc:payout-info))\n\n###Response Details\nIf successful, the response HTTP status code is 201 Created.\nThe response body 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 <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>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>50</minimal-payout-amount>\\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>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 <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>50</minimal-payout-amount>\\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>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 <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 </payout-info>\\n <payout-info>\\n <payout-type>SEPA</payout-type>\\n <base-currency>EUR</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>44352</bank-id>\\n <iban>74466398987773288292902</iban>\\n <swift-bic>hhsjeuue</swift-bic>\\n <country>AT</country>\\n <city>Leitendorf</city>\\n <address>Anzengrubergasse 14</address>\\n <zip>8700</zip>\\n <bank-account-id>377289209</bank-account-id>\\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>joe.vendor@bluesnap.com</email>\\n <name>Important Vendor</name>\\n <first-name>Joe</first-name>\\n <last-name>Smith</last-name>\\n <phone>0549766778</phone>\\n <address>123 Main Street</address>\\n <city>Boston</city>\\n <country>US</country>\\n <state>MA</state>\\n <zip>12356</zip>\\n <tax-id>123456789</tax-id>\\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>21212</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.name@vendor.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 <city>Boston</city>\\n <state>MA</state>\\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 </payout-info>\\n</vendor>\",\n \"language\": \"xml\",\n \"name\": \"XML\"\n }\n ]\n}\n[/block]","excerpt":"","slug":"create-vendor","type":"endpoint","title":"Create Vendor"}postCreate Vendor
Definition
{{ api_url }}{{ page_api_url }}
Documentation
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.
Important: Vendor verification requirements
To be eligible for payout, the vendor must meet vendor verification requirements.
Request Content
vendor container required, contains the following properties (see vendor):
email string required
name string optional
first-name string optional
last-name string optional
phone string optional
address string optional
city string optional
country string required
state string optional applicable if country = US or CA (See State and Province Codes).
zip string optional
tax-id string optional
vat-id string optional
default-payout-currency string optional
frequency string optional
delay integer optional
vendor-principal container optional; (see vendor-principal)
vendor-agreement container optional; (see vendor-agreement)
payout-info container optional; (see payout-info)
Response Details
If successful, the response HTTP status code is 201 Created.
The response body contains the vendor-id.
The vendor-id is required for all future transactions associated with this vendor.
Examples
Request Examples
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>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>
<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>50</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>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>
<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>50</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">
<email>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>
<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>
</payout-info>
<payout-info>
<payout-type>SEPA</payout-type>
<base-currency>EUR</base-currency>
<name-on-account>Jane Shopper</name-on-account>
<bank-account-type>CHECKING</bank-account-type>
<bank-account-class>PERSONAL</bank-account-class>
<bank-name>UniCredit</bank-name>
<bank-id>44352</bank-id>
<iban>74466398987773288292902</iban>
<swift-bic>hhsjeuue</swift-bic>
<country>AT</country>
<city>Leitendorf</city>
<address>Anzengrubergasse 14</address>
<zip>8700</zip>
<bank-account-id>377289209</bank-account-id>
</payout-info>
</vendor>HTTP/ 1.1 201 Created
Location: https://sandbox.bluesnap.com/services/2/vendors/19575974Example Descriptions
Create Vendor: Individual
This 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.
Create Vendor: Business
This 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.
Create Vendor: with 2 bank accounts
This 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.
The following conversion logic will apply:
- 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.
- 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.
API Explorer
To test out a call, enter the request content below and then click Try it!
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.
<vendor xmlns="http://ws.plimus.com">
<email>joe.vendor@bluesnap.com</email>
<name>Important Vendor</name>
<first-name>Joe</first-name>
<last-name>Smith</last-name>
<phone>0549766778</phone>
<address>123 Main Street</address>
<city>Boston</city>
<country>US</country>
<state>MA</state>
<zip>12356</zip>
<tax-id>123456789</tax-id>
<default-payout-currency>USD</default-payout-currency>
<vendor-principal>
<first-name>Joe</first-name>
<last-name>Smith</last-name>
<address>123 Main Street</address>
<city>Boston</city>
<country>US</country>
<zip>21212</zip>
<dob>28-09-9999</dob>
<personal-identification-number>1234</personal-identification-number>
<driver-license-number>561196411</driver-license-number>
<email>principal.name@vendor.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>
<city>Boston</city>
<state>MA</state>
<address>1 bank address</address>
<zip>12345</zip>
<bank-account-id>36628822</bank-account-id>
<minimal-payout-amount>50</minimal-payout-amount>
</payout-info>
</vendor>