Create Vendor

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.

❗️
The previous payout-info object used in this request has been deprecated and replaced with payout-configuration to support regional payout. You must update your requests per the structure detailed below.
If you call this API with payout-info or if the merchant is not configured for regional payout, an error will be returned.

Important: Vendor verification requirements

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.

In addition, to be eligible for payout, the vendor must meet vendor verification requirements

Request Content

vendor container required, contains the following properties (see vendor):

Property	Type	Required
`address`	string	optional
`city`	string	optional
`country`	string	required
`email`	string	required
`first-name` `last-name`	string	optional
`ipn-url`	string	optional
`name`	string	optional
`payout-configuration`	container	Optional. Inherits BlueSnap merchant’s payout bank settings by default. (See payout-configuration)
`phone`	string	optional
`state`	string	applicable if country = US or CA (See State and Province Codes)
`tax-id`	string	optional
`terms-of-service`	container	required; (see terms-of-service)
`vat-id`	string	optional
`vendor-agreement`	container	optional; (see vendor-agreement)
`vendor-principal`	container	optional; (see vendor-principal)
`vendor-url`	string	optional
`zip`	string	optional

Response Details

If successful, the response HTTP status code is 201 Created.
The response header 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>[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>12345</zip>
  <ipn-url>https://ipnaddress.com</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>
    <driver-license-number>561196411</driver-license-number>
    <email>[email protected]</email>
  </vendor-principal>
  <vendor-agreement>
    <commission-percent>30</commission-percent>
  </vendor-agreement>
  <terms-of-service>
    <accepted-date>18-02-2026</accepted-date>
    <vendor-ip>123.65.45.32</vendor-ip>
  </terms-of-service>
  <payout-configuration>
    <payout-frequency>MONTHLY</payout-frequency>
    <review-delay>14</review-delay>
    <default-legal-entity>US</default-legal-entity>
    <regions>
      <region>US</region>
      <default-currency>USD</default-currency>
      <currency-by-region>
        <currency-code>USD</currency-code>
        <status>Active</status>
        <payout-payment-type>ACH</payout-payment-type>
        <minimum-payment-amount>50</minimum-payment-amount>
        <reserve>
          <merchant-reserve>
            <keep-on-merchant-reserve>200</keep-on-merchant-reserve>
          </merchant-reserve>
        </reserve>
        <bank-details>
          <country>US</country>
          <state>MA</state>
          <city>Juneau</city>
          <address-1>1 bank address</address-1>
          <zip-code>12345</zip-code>
          <payment-reference>Payment for vendor 1234</payment-reference>
          <bic>EXBN01</bic>
          <bank-name>Leumi</bank-name>
          <iban>ABC123456789DEF</iban>
          <ach-account-class>PERSONAL</ach-account-class>
          <ach-account-type>CHECKING</ach-account-type>
          <name-on-account>vendor</name-on-account>
          <status>Pending</status>
        </bank-details>
      </currency-by-region>
    </regions>
  </payout-configuration>
</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>
  <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>
    <driver-license-number>561196411</driver-license-number>
    <email>[email protected]</email>
  </vendor-principal>
  <vendor-agreement>
    <commission-percent>30</commission-percent>
  </vendor-agreement>
  <terms-of-service>
    <accepted-date>18-02-2026</accepted-date>
    <vendor-ip>123.65.45.32</vendor-ip>
  </terms-of-service>
  <payout-configuration>
    <payout-frequency>MONTHLY</payout-frequency>
    <review-delay>14</review-delay>
    <default-legal-entity>US</default-legal-entity>
    <regions>
      <region>US</region>
      <default-currency>USD</default-currency>
      <currency-by-region>
        <currency-code>USD</currency-code>
        <status>Active</status>
        <payout-payment-type>ACH</payout-payment-type>
        <minimum-payment-amount>50</minimum-payment-amount>
        <reserve>
          <merchant-reserve>
            <keep-on-merchant-reserve>200</keep-on-merchant-reserve>
          </merchant-reserve>
        </reserve>
        <bank-details>
          <country>US</country>
          <state>MA</state>
          <city>Juneau</city>
          <address-1>1 bank address</address-1>
          <zip-code>12345</zip-code>
          <payment-reference>Payment for vendor 1234</payment-reference>
          <bic>EXBN01</bic>
          <bank-name>Leumi</bank-name>
          <iban>ABC123456789DEF</iban>
          <ach-account-class>CORPORATE</ach-account-class>
          <ach-account-type>CHECKING</ach-account-type>
          <name-on-account>vendor</name-on-account>
          <status>Pending</status>
        </bank-details>
      </currency-by-region>
    </regions>
  </payout-configuration>
</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>[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>02453</zip>
  <ipn-url>https://ipnaddress.com</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>
    <driver-license-number>561196411</driver-license-number>
    <email>[email protected]</email>
  </vendor-principal>
  <vendor-agreement>
    <commission-percent>30</commission-percent>
  </vendor-agreement>
  <terms-of-service>
    <accepted-date>18-02-2026</accepted-date>
    <vendor-ip>123.65.45.32</vendor-ip>
  </terms-of-service>
  <payout-configuration>
    <review-delay>15</review-delay>
    <payout-frequency>MONTHLY</payout-frequency>
    <default-legal-entity>US</default-legal-entity>
    <regions>
        <region>US</region>
        <default-currency>USD</default-currency>
        <currency-by-region>
            <currency-code>USD</currency-code>
            <payout-payment-type>ACH</payout-payment-type>
            <minimum-payment-amount>35</minimum-payment-amount>
            <reserve>
                <merchant-reserve>
                    <keep-on-merchant-reserve>200</keep-on-merchant-reserve>
                </merchant-reserve>
            </reserve>
            <bank-details>
                <country>US</country>
                <state>MA</state>
                <city>Juneau</city>
                <address-1>1 bank address</address-1>
                <zip-code>02453</zip-code>
                <payment-reference>Payment for vendor 1234</payment-reference>
                <bank-id>123456789</bank-id>
                <bank-name>Leumi</bank-name>
                <account-id>36628822</account-id>
                <name-on-account>vendor</name-on-account>
                <ach-account-class>PERSONAL</ach-account-class>
                <ach-account-type>CHECKING</ach-account-type>
            </bank-details>
        </currency-by-region>
    </regions>
    <regions>
        <region>UK</region>
        <default-currency>GBP</default-currency>
        <currency-by-region>
            <currency-code>GBP</currency-code>
            <status>A</status>
            <payout-payment-type>WIRE</payout-payment-type>
            <minimum-payment-amount>55</minimum-payment-amount>
            <reserve>
                <merchant-reserve>
                    <keep-on-merchant-reserve>60</keep-on-merchant-reserve>
                </merchant-reserve>
            </reserve>
            <bank-details>
                <country>UK</country>
                <city>Memphis</city>
                <zip-code>87458</zip-code>
                <payment-reference>my payment reference</payment-reference>
                <bank-id>026009593</bank-id>
                <bank-name>Bank of UK</bank-name>
                <account-id>89659854</account-id>
                <name-on-account>FedEx Cross Border Logistics, Inc.</name-on-account>
            </bank-details>
        </currency-by-region>
        <currency-by-region>
            <currency-code>EUR</currency-code>
            <status>A</status>
            <payout-payment-type>WIRE</payout-payment-type>
            <minimum-payment-amount>40</minimum-payment-amount>
            <reserve>
                <merchant-reserve>
                    <keep-on-merchant-reserve>0</keep-on-merchant-reserve>
                </merchant-reserve>
            </reserve>
        </currency-by-region>
    </regions>
  </payout-configuration>
</vendor>'

Response Examples

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