{"_id":"593fe2272418a7003933a371","category":{"_id":"593fe2262418a7003933a362","version":"593fe2262418a7003933a35e","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"},"user":"560d5913af97231900938124","parentDoc":null,"project":"57336fd5a6a9c40e00e13a0b","version":{"_id":"593fe2262418a7003933a35e","project":"57336fd5a6a9c40e00e13a0b","__v":1,"createdAt":"2017-06-13T13:01:26.536Z","releaseDate":"2017-06-13T13:01:26.536Z","categories":["593fe2262418a7003933a35f","593fe2262418a7003933a360","593fe2262418a7003933a361","593fe2262418a7003933a362","593fe2262418a7003933a363","593fe2262418a7003933a364","593fe2262418a7003933a365"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"3.21.2","version_clean":"8976.0.0-Basics","version":"8976-Basics"},"__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-03-17T15:51:51.724Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":1,"body":"##Creating vendor accounts\nTo create a new vendor account and begin the onboarding process, you'll submit the vendor's information via the Create Vendor request. To fully board your vendor, you'll collect all the necessary [Know your customer](https://en.wikipedia.org/wiki/Know_your_customer) (KYC), banking, and any additional required information from them, and you'll submit to BlueSnap for verification. \n\nVendors can be created and begin selling with just country and email. The vendor's account must have all the [necessary information](/docs/vendor-verification-requirements) to be eligible for payout. This is because BlueSnap must first verify the vendor's identity before any funds can be paid out. \n<br />\n[block:callout]\n{\n  \"type\": \"success\",\n  \"title\": \"Submit all necessary information in advance\",\n  \"body\": \"Collecting all the [necessary information for payout](/docs/vendor-verification-requirements#section-requirements-for-payout) (commission rate, banking information, business owner information, etc.) up-front and submitting via the Create Vendor request means that you won't have to ask your vendor for their information more than once. Plus, you'll avoid any payout delays.\\n\\n**Note**: It's very important to define your vendor's commission rate during the initial vendor creation, so that transactions can be split appropriately.\"\n}\n[/block]\nAt a minimum, include the vendor's country and email in the request. \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\\\": \\\"jane.shopper:::at:::bluesnap.com\\\", \\n    \\\"country\\\": \\\"US\\\"\\n     ... \\n}'\",\n      \"language\": \"curl\",\n      \"name\": \"JSON\"\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>jane.shopper@bluesnap.com</email>\\n    <country>US</country>\\n    ...\\n</vendor>'\",\n      \"language\": \"curl\",\n      \"name\": null\n    }\n  ]\n}\n[/block]\nA successful response will include the vendor ID, a unique ID assigned to the vendor, which will be required for future requests involving this vendor (in this example, the vendor ID is 19575974).\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\": \"201 Created\"\n    }\n  ]\n}\n[/block]\n####For more information: \nVisit our API Reference for additional examples and a  complete list of request properties: \n\n  * [Create Vendor - JSON](/v2.1/docs/create-vendor) \n  * [Create Vendor - XML](/v2.0/docs/create-vendor)  \n<br />\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Webhooks\",\n  \"body\": \"Any changes to your vendor’s account status will be sent to you via the `VENDOR_STATUS_CHANGED` webhook. The possible account statuses are created, approved, and declined. \\n\\nBe sure that you have both Default and On-Demand webhooks enabled in your [account settings](https://support.bluesnap.com/docs/ipn-setup).\"\n}\n[/block]\n##Staying informed with webhooks\nBlueSnap uses webhooks called Instant Payment Notifications (IPN's) to keep you informed. They are HTTP POST messages that are triggered on certain events. To learn how to enable webhooks, click [here](https://support.bluesnap.com/docs/ipn-setup).\n\nBelow is a list of some common webhooks that will keep you informed of your marketplace activity related to vendor onboarding, payout, and transactions. \n\n* Vendor Status Changed \n* Under Vendor Review \n* Payout \n* Charge\n* Auth Only \n* Refund\n\nFor a complete list of webhooks, click [here](https://support.bluesnap.com/docs/ipn-name-reference). \n[block:callout]\n{\n  \"type\": \"success\",\n  \"body\": \"`vendorID` will be sent in the body of the message to help you identify which vendor was involved in the event.\",\n  \"title\": \"Using vendor ID to link a vendor to the event\"\n}\n[/block]\n<a class=\"btn btn-primary\" href=\"#\" role=\"button\">Back to Top</a>\n\n##Next: Vendor Verification Requirements\nNow that you've created your vendor account and started the onboarding process, you can jump right into learning about vendor verification requirements. \n\n**[➔ Vendor Verification Requirements](/docs/vendor-verification-requirements)**","excerpt":"Learn how to create a vendor account and begin boarding your vendor using BlueSnap's Payment API.\nIf you have questions after reading this guide, check out our answers to [frequently asked questions](https://support.bluesnap.com/docs/merchant-faqs#section--what-is-a-marketplace-).","slug":"vendor-onboarding","type":"basic","title":"Vendor Onboarding"}

Vendor Onboarding

Learn how to create a vendor account and begin boarding your vendor using BlueSnap's Payment API. If you have questions after reading this guide, check out our answers to [frequently asked questions](https://support.bluesnap.com/docs/merchant-faqs#section--what-is-a-marketplace-).

Creating vendor accounts

To create a new vendor account and begin the onboarding process, you'll submit the vendor's information via the Create Vendor request. To fully board your vendor, you'll collect all the necessary Know your customer (KYC), banking, and any additional required information from them, and you'll submit to BlueSnap for verification.

Vendors can be created and begin selling with just country and email. The vendor's account must have all the necessary information to be eligible for payout. This is because BlueSnap must first verify the vendor's identity before any funds can be paid out.

Submit all necessary information in advance

Collecting all the necessary information for payout (commission rate, banking information, business owner information, etc.) up-front and submitting via the Create Vendor request means that you won't have to ask your vendor for their information more than once. Plus, you'll avoid any payout delays.

Note: It's very important to define your vendor's commission rate during the initial vendor creation, so that transactions can be split appropriately.

At a minimum, include the vendor's country and email in the request.

curl -v -X POST https://sandbox.bluesnap.com/services/2/vendors \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{ 
    "email": "jane.shopper@bluesnap.com", 
    "country": "US"
     ... 
}'
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>jane.shopper@bluesnap.com</email>
    <country>US</country>
    ...
</vendor>'

A successful response will include the vendor ID, a unique ID assigned to the vendor, which will be required for future requests involving this vendor (in this example, the vendor ID is 19575974).

HTTP/ 1.1 201 Created
Location: https://sandbox.bluesnap.com/services/2/vendors/19575974

For more information:

Visit our API Reference for additional examples and a complete list of request properties:

Webhooks

Any changes to your vendor’s account status will be sent to you via the VENDOR_STATUS_CHANGED webhook. The possible account statuses are created, approved, and declined.

Be sure that you have both Default and On-Demand webhooks enabled in your account settings.

Staying informed with webhooks

BlueSnap uses webhooks called Instant Payment Notifications (IPN's) to keep you informed. They are HTTP POST messages that are triggered on certain events. To learn how to enable webhooks, click here.

Below is a list of some common webhooks that will keep you informed of your marketplace activity related to vendor onboarding, payout, and transactions.

  • Vendor Status Changed
  • Under Vendor Review
  • Payout
  • Charge
  • Auth Only
  • Refund

For a complete list of webhooks, click here.

Using vendor ID to link a vendor to the event

vendorID will be sent in the body of the message to help you identify which vendor was involved in the event.

Back to Top

Next: Vendor Verification Requirements

Now that you've created your vendor account and started the onboarding process, you can jump right into learning about vendor verification requirements.

➔ Vendor Verification Requirements