Create Vendor · Developer Hub

{"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*    **required**, contains the following properties (see [vendor](doc:vendor)):\n      `email` *string*    **required**      \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*    **required**\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      `vendor-url` *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      `ipn-url` *string*    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>12345</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 \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>12345</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":"61a5208deadb750070998e9c","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Marketplace","slug":"marketplace","order":13,"from_sync":false,"reference":false,"_id":"61a5208deadb750070998e90","version":"61a5208deadb750070998f48","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.40 Release","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["61a5208deadb750070998e87","61a5208deadb750070998e88","61a5208deadb750070998e89","61a5208deadb750070998e8a","61a5208deadb750070998e8b","61a5208deadb750070998e8c","61a5208deadb750070998e8d","61a5208deadb750070998e8e","61a5208deadb750070998e8f","61a5208deadb750070998e90","61a5208deadb750070998e91","61a5208deadb750070998e92","61a5208deadb750070998e93","61a5208deadb750070998e94","61a5208deadb750070998e95","61a5208deadb750070998e96","61a5208deadb750070998e97","61a5208deadb750070998e98","61a5208deadb750070998e99","61a5208deadb750070998e9a"],"_id":"61a5208deadb750070998f48","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"60fed269718a45001c25b4a0","createdAt":"2018-04-24T15:24:22.608Z","releaseDate":"2018-04-24T15:24:22.608Z"},"createdAt":"2016-11-23T18:28:17.881Z","githubsync":"","__v":0}

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

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.

Try it in the API Explorer

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
      vendor-url 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)
      ipn-url 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

Create Vendor - Individual

Business

with 2 bank accounts

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>
  <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>[email protected]</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>123456789</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>
    <payment-reference>Payment for vendor 1234</payment-reference>
    <refund-reserve>200</refund-reserve>
  </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>[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>
  <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>[email protected]</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>123456789</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>
    <payment-reference>Payment for vendor 1234</payment-reference>
    <refund-reserve>200</refund-reserve>
  </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>[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>123456</zip>
  <default-payout-currency>USD</default-payout-currency>
  <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>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>
  <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>123456789</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>
    <payment-reference>Payment for vendor 1234</payment-reference>
    <refund-reserve>200</refund-reserve>
  </payout-info>
  <payout-info>
    <payout-type>CHAPS</payout-type>
    <base-currency>GBP</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>123456</bank-id>
    <country>UK</country>
    <city>London</city>
    <address>Anzengrubergasse 14</address>
    <zip>8700</zip>
    <bank-account-id>12345678</bank-account-id>
    <minimal-payout-amount>25</minimal-payout-amount>
    <payment-reference>Payment for vendor 1234</payment-reference>
  </payout-info>
</vendor>'

Response Examples

Create Vendor Response

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

Example 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.

XML

<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>
  <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>[email protected]</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>123456789</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>
    <payment-reference>Payment for vendor 1234</payment-reference>
    <refund-reserve>200</refund-reserve>
  </payout-info>
</vendor>

Method	{{ tryResults.method }}
Request Headers	{{ tryResults.requestHeaders }}
URL	{{ tryResults.url }}
Request Data	{{ tryResults.data }}
Status
Response Headers	{{ tryResults.responseHeaders }}

Developer Hub

Payment API (XML)

Card/Wallet Transactions

PayPal Transactions

ACH/ECP Transactions

iDEAL Transactions

Local Bank Transfer transactions

SEPA Direct Debit Transactions

Sofort Transactions

Batch Transactions

Refunds

Vaulted Shoppers

Subscriptions

Fraud Review

Marketplace

Wallets

Errors

Resources

Test Data & Codes

Guides & Tools

Mobile SDK

postCreate Vendor

Definition

Documentation