{"_id":"59dfa8f55c0bae001c2e8b11","category":{"_id":"59dfa8f45c0bae001c2e8aec","version":"59dfa8f45c0bae001c2e8ae8","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"},"parentDoc":null,"project":"57336fd5a6a9c40e00e13a0b","user":"560d5913af97231900938124","version":{"_id":"59dfa8f45c0bae001c2e8ae8","project":"57336fd5a6a9c40e00e13a0b","__v":1,"createdAt":"2017-10-12T17:40:04.535Z","releaseDate":"2017-10-12T17:40:04.535Z","categories":["59dfa8f45c0bae001c2e8ae9","59dfa8f45c0bae001c2e8aea","59dfa8f45c0bae001c2e8aeb","59dfa8f45c0bae001c2e8aec","59dfa8f45c0bae001c2e8aed","59dfa8f45c0bae001c2e8aee","59dfa8f45c0bae001c2e8aef","59dfa8f45c0bae001c2e8af0"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"3.23. Release","version_clean":"8976.0.0-Basics","version":"8976-Basics"},"__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-03-17T15:52:02.716Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":3,"body":"This section will cover the following topics: \n* [Updating vendor accounts overview](#section-updating-vendor-accounts-overview)\n* [Modifiable vendor account properties](#section-modifiable-vendor-account-properties)\n* [Updating vendor properties and changes to payout status](#section-updating-vendor-properties-and-changes-to-payout-status)\n* [How it works](#section-how-it-works)\n\n##Updating vendor accounts overview\nOnce you've created your vendor's account, you'll be able to update it at any time. \nWith the Update Vendor request, you can: \n\n1. Add additional information (i.e. add missing KYC information for vendor onboarding)\n2. Update existing information (i.e. email, payout information, commission rate etc.) \n<br />\n[block:callout]\n{\n  \"type\": \"success\",\n  \"body\": \"To be eligible for payout, make sure all necessary vendor information has been submitted to BlueSnap. To see code samples with all information needed for payout, click [here](/docs/vendor-verification-requirements#section-requirements-for-payout).\",\n  \"title\": \"Make sure your vendor is eligible for payout\"\n}\n[/block]\n<a class=\"btn btn-primary\" href=\"#\" role=\"button\">Back to Top</a>\n\n<hr>\n## Modifiable vendor account properties\nAny of the following properties may be updated: \n\n* Vendor address\n* Vendor company name\n* Vendor email\n* Vendor first and last name\n* Vendor business name\n* Vendor phone\n* Vendor frequency and delay\n* Vendor principal\n* Vendor agreement\n* Vendor payout \n\n<hr>\n## Updating vendor properties and changes to payout status\nOnce your vendor’s payout status has been approved, updating certain properties (listed below) will result in their payout status changing to **Pending** or **Incomplete**, as this information will require BlueSnap's review. *Please note*: your vendor’s payout will be suspended until approved.\n\n**vendor**\n`firstName`, `lastName`, `name`\n\n**vendorPrincipal**\n`country`, `driverLicenseNumber`, `firstName`, `lastName`, `passportNumber`, `personalIdentificationNumber`\n\n**payoutInfo** \n`bankAccountClass`, `bankAccountId`, `bankAccountType`, `bankId`, `bankName`, `city`, `country`, `iban`, `nameOnAccount`, `state`, `swiftBic`\n\n<hr>\n\n##How it works\nInclude the vendor ID within the API endpoint of the request as such: \n`https://sandbox.bluesnap.com/services/2/vendors/19575974`\n \nIn the body of the request, add additional vendor account properties or update existing ones. \n\nIn this example, suppose we wish to update a vendor with a vendor ID of 514147. We will change the Commission Percent property to 45, meaning that this vendor will now get 45 percent of the funds for a sale.  \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -v -X PUT https://sandbox.bluesnap.com/services/2/vendors/514147 \\\\\\n-H 'Content-Type: application/json' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n{\\n    \\\"email\\\": \\\"marketplaceMerchantEmail:::at:::example.com\\\",\\n    \\\"firstName\\\": \\\"Joe\\\",\\n    \\\"lastName\\\": \\\"Smith\\\",\\n    \\\"phone\\\": \\\"1-123-456-7890\\\",\\n    \\\"address\\\": \\\"123 Main Street\\\",\\n    \\\"city\\\": \\\"Boston\\\",\\n    \\\"country\\\": \\\"US\\\",\\n    \\\"state\\\":\\\"MA\\\",\\n    \\\"zip\\\": \\\"123456\\\",\\n    \\\"defaultPayoutCurrency\\\": \\\"USD\\\", \\n    \\\"vendorPrincipal\\\": {\\n        \\\"firstName\\\": \\\"Joe\\\",\\n        \\\"lastName\\\": \\\"Smith\\\",\\n        \\\"address\\\": \\\"123 Main Street\\\",\\n        \\\"city\\\": \\\"Boston\\\",\\n        \\\"country\\\": \\\"US\\\",\\n        \\\"zip\\\": \\\"123456\\\",\\n        \\\"dob\\\": \\\"28-09-9999\\\",\\n        \\\"personalIdentificationNumber\\\": \\\"1234\\\",\\n      \\t\\\"driverLicenseNumber\\\": \\\"7676234872122\\\", \\n        \\\"email\\\": \\\"individual.vendor@bluesnap.com\\\"\\n    },\\n    \\\"vendorAgreement\\\": {\\n        \\\"commissionPercent\\\": \\\"45\\\", \\n         \\\"accountStatus\\\": \\\"ACTIVE\\\"\\n    },\\n    \\\"payoutInfo\\\": [{\\n        \\\"payoutType\\\": \\\"ACH\\\",\\n        \\\"baseCurrency\\\": \\\"USD\\\",\\n        \\\"nameOnAccount\\\": \\\"vendor\\\",\\n        \\\"bankAccountType\\\": \\\"CHECKING\\\",\\n        \\\"bankAccountClass\\\": \\\"PERSONAL\\\",\\n        \\\"bankName\\\": \\\"Leumi\\\",\\n        \\\"bankId\\\": \\\"12445\\\",\\n        \\\"country\\\": \\\"US\\\",\\n        \\\"state\\\":\\\"MA\\\",\\n        \\\"city\\\": \\\"Juneau\\\",\\n        \\\"address\\\": \\\"1 bank address\\\",\\n        \\\"zip\\\": \\\"12345\\\",\\n        \\\"bankAccountId\\\": \\\"36628822\\\"\\n    }]\\n}'\",\n      \"language\": \"curl\",\n      \"name\": \"JSON\"\n    },\n    {\n      \"code\": \"curl -v -X PUT https://sandbox.bluesnap.com/services/2/vendors/514147 \\\\\\n-H 'Content-Type: application/xml' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n<vendor xmlns=\\\"http://ws.plimus.com\\\">\\n  <email>marketplaceMerchantEmail@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>7676234872</driver-license-number>\\n    <email>individual.vendor@bluesnap.com</email>\\n  </vendor-principal>\\n  <vendor-agreement>\\n    <commission-percent>45</commission-percent>\\n    <account-status>ACTIVE</account-status>\\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</vendor>'\",\n      \"language\": \"curl\",\n      \"name\": \"XML\"\n    }\n  ]\n}\n[/block]\n<br />\n[block:callout]\n{\n  \"type\": \"success\",\n  \"title\": \"Retrieving the vendor account\",\n  \"body\": \"Use the Retrieve Vendor request to get the vendor's account information, which you can use to build up the Update Vendor request body. \\n\\n* [Retrieve Vendor - JSON](/v2.1/docs/retrieve-vendor)\\n* [Retrieve Vendor - XML](/v2.0/docs/retrieve-vendor)\"\n}\n[/block]\n###For more information:\nVisit our API Reference for Update Vendor examples and a  complete list of request properties: \n\n  * [Update Vendor - JSON](/v2.1/docs/update-vendor) \n  * [Update Vendor - XML](/v2.0/docs/update-vendor)  \n<br />  \n\n<a class=\"btn btn-primary\" href=\"#\" role=\"button\">Back to Top</a>\n\n<hr>\n\n##Next: Processing Transactions\nNow that you've learned how to update your vendor's account, you're ready to starting processing transactions on your vendor's behalf. \n\n**[➔ Processing Transactions](/docs/processing-transactions)**","excerpt":"Learn how to update a vendor account 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":"updating-vendor-accounts","type":"basic","title":"Updating Vendor Accounts"}

Updating Vendor Accounts

Learn how to update a vendor account 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-).

This section will cover the following topics:

Updating vendor accounts overview

Once you've created your vendor's account, you'll be able to update it at any time.
With the Update Vendor request, you can:

  1. Add additional information (i.e. add missing KYC information for vendor onboarding)
  2. Update existing information (i.e. email, payout information, commission rate etc.)

Make sure your vendor is eligible for payout

To be eligible for payout, make sure all necessary vendor information has been submitted to BlueSnap. To see code samples with all information needed for payout, click here.

Back to Top


Modifiable vendor account properties

Any of the following properties may be updated:

  • Vendor address
  • Vendor company name
  • Vendor email
  • Vendor first and last name
  • Vendor business name
  • Vendor phone
  • Vendor frequency and delay
  • Vendor principal
  • Vendor agreement
  • Vendor payout


Updating vendor properties and changes to payout status

Once your vendor’s payout status has been approved, updating certain properties (listed below) will result in their payout status changing to Pending or Incomplete, as this information will require BlueSnap's review. Please note: your vendor’s payout will be suspended until approved.

vendor
firstName, lastName, name

vendorPrincipal
country, driverLicenseNumber, firstName, lastName, passportNumber, personalIdentificationNumber

payoutInfo
bankAccountClass, bankAccountId, bankAccountType, bankId, bankName, city, country, iban, nameOnAccount, state, swiftBic


How it works

Include the vendor ID within the API endpoint of the request as such:
https://sandbox.bluesnap.com/services/2/vendors/19575974

In the body of the request, add additional vendor account properties or update existing ones.

In this example, suppose we wish to update a vendor with a vendor ID of 514147. We will change the Commission Percent property to 45, meaning that this vendor will now get 45 percent of the funds for a sale.

curl -v -X PUT https://sandbox.bluesnap.com/services/2/vendors/514147 \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
    "email": "marketplaceMerchantEmail@example.com",
    "firstName": "Joe",
    "lastName": "Smith",
    "phone": "1-123-456-7890",
    "address": "123 Main Street",
    "city": "Boston",
    "country": "US",
    "state":"MA",
    "zip": "123456",
    "defaultPayoutCurrency": "USD", 
    "vendorPrincipal": {
        "firstName": "Joe",
        "lastName": "Smith",
        "address": "123 Main Street",
        "city": "Boston",
        "country": "US",
        "zip": "123456",
        "dob": "28-09-9999",
        "personalIdentificationNumber": "1234",
      	"driverLicenseNumber": "7676234872122", 
        "email": "individual.vendor@bluesnap.com"
    },
    "vendorAgreement": {
        "commissionPercent": "45", 
         "accountStatus": "ACTIVE"
    },
    "payoutInfo": [{
        "payoutType": "ACH",
        "baseCurrency": "USD",
        "nameOnAccount": "vendor",
        "bankAccountType": "CHECKING",
        "bankAccountClass": "PERSONAL",
        "bankName": "Leumi",
        "bankId": "12445",
        "country": "US",
        "state":"MA",
        "city": "Juneau",
        "address": "1 bank address",
        "zip": "12345",
        "bankAccountId": "36628822"
    }]
}'
curl -v -X PUT https://sandbox.bluesnap.com/services/2/vendors/514147 \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
<vendor xmlns="http://ws.plimus.com">
  <email>marketplaceMerchantEmail@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>7676234872</driver-license-number>
    <email>individual.vendor@bluesnap.com</email>
  </vendor-principal>
  <vendor-agreement>
    <commission-percent>45</commission-percent>
    <account-status>ACTIVE</account-status>
  </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>
</vendor>'


Retrieving the vendor account

Use the Retrieve Vendor request to get the vendor's account information, which you can use to build up the Update Vendor request body.

For more information:

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

Back to Top


Next: Processing Transactions

Now that you've learned how to update your vendor's account, you're ready to starting processing transactions on your vendor's behalf.

➔ Processing Transactions