{"_id":"59df6a593b756800107b20aa","category":{"_id":"59df6a523b756800107b2028","version":"59df6a523b756800107b201e","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","project":"57336fd5a6a9c40e00e13a0b","parentDoc":null,"version":{"_id":"59df6a523b756800107b201e","project":"57336fd5a6a9c40e00e13a0b","__v":1,"createdAt":"2017-10-12T13:12:50.128Z","releaseDate":"2017-10-12T13:12:50.128Z","categories":["59df6a523b756800107b201f","59df6a523b756800107b2020","59df6a523b756800107b2021","59df6a523b756800107b2022","59df6a523b756800107b2023","59df6a523b756800107b2024","59df6a523b756800107b2025","59df6a523b756800107b2026","59df6a523b756800107b2027","59df6a523b756800107b2028","59df6a523b756800107b2029","59df6a523b756800107b202a","59df6a523b756800107b202b","59df6a523b756800107b202c","59df6a523b756800107b202d","59df6a523b756800107b202e"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"3.23 Release","version_clean":"8976.0.0-XML","version":"8976-XML"},"__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-11-23T18:30:24.271Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"put","results":{"codes":[]},"settings":"","examples":{"codes":[]},"auth":"optional","params":[{"_id":"58402c63e3e04b230055c684","ref":"","in":"path","required":true,"desc":"BlueSnap identifier for the vendor","default":"","type":"int","name":"vendor-id"}],"url":"/vendors/:vendor-id"},"isReference":false,"order":2,"body":"The Update Vendor request enables you to change any of the following properties for an existing vendor:\n* Vendor address\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**Note**: Modifying certain vendor properties may result in vendor payout suspension. Click [here](/v1.0/docs/updating-vendor-accounts#section-updating-vendor-properties-and-changes-to-payout-status) to learn more. \n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Important\",\n  \"body\": \"* It is suggested that you first retrieve the vendor and then modify the desired property.\\n\\n* To be eligible for payout, make sure all necessary vendor information has been submitted to BlueSnap. To see the payout requirements, click [here](/docs/vendor-verification-requirements#section-requirements-for-payout).\"\n}\n[/block]\n###Request Content\n`vendor` *container* &nbsp;&nbsp;&nbsp;<span style=\"color:#F37500\">**required**</span>, contains the following properties (see [vendor](doc:vendor)):\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`email` *string* &nbsp;&nbsp;&nbsp;<span style=\"color:#F37500\">**required**</span>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; \n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`name` *string* &nbsp;&nbsp;&nbsp; optional\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`first-name` *string* &nbsp;&nbsp;&nbsp; optional\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`last-name` *string* &nbsp;&nbsp;&nbsp; optional\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`phone` *string* &nbsp;&nbsp;&nbsp; optional\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`address` *string* &nbsp;&nbsp;&nbsp; optional\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`city` *string* &nbsp;&nbsp; optional\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`country` *string* &nbsp;&nbsp;<span style=\"color:#F37500\">**required**</span>\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`state` *string* &nbsp;&nbsp;<span style=\"color:#F37500\">**required**</span> if `payout-info` included and country = US or CA (See [State and Province Codes](http://developers.bluesnap.com/docs/state-and-province-codes)). \n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`zip` *string* &nbsp;&nbsp; optional\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`tax-id` *string* &nbsp;&nbsp;&nbsp;optional \n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`vat-id` *string* &nbsp;&nbsp;&nbsp;optional\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`default-payout-currency` *string* &nbsp;&nbsp;&nbsp;optional &nbsp;&nbsp;&nbsp;\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`frequency` *string* &nbsp;&nbsp;&nbsp;optional &nbsp;&nbsp;&nbsp;\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`delay` *integer* &nbsp;&nbsp;&nbsp;optional &nbsp;&nbsp;&nbsp;\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`vendor-principal` *container* &nbsp;&nbsp;&nbsp; optional; (see [vendor-principal](doc:vendor-principal))\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`vendor-agreement` *container* &nbsp;&nbsp;&nbsp; optional; (see [vendor-agreement](doc:vendor-agreement))\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`payout-info` *container* &nbsp;&nbsp;&nbsp;optional; (see [payout-info](doc:payout-info))\n\n###Response Details\nIf successful, the response HTTP status code is 204 No Content\n\n#Request Example\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/xml' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n<vendor xmlns=\\\"http://ws.plimus.com\\\">\\n    <email>vendor&#x40;bluesnap.com</email>\\n    <name>Important Vendor</name>\\n    <first-name>Joe</first-name>\\n    <last-name>Smith</last-name>\\n    <address>123 Main Street</address>\\n    <city>testing city</city>\\n    <zip>4640802</zip>\\n    <country>us</country>\\n    <phone>0549766778</phone>\\n    <state>MA</state>\\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>Juneau</city>\\n        <zip>12345</zip>\\n        <country>US</country>\\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:::at:::vendor.com</email>\\n    </vendor-principal>\\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-class>PERSONAL</bank-account-class>\\n        <bank-account-type>CHECKING</bank-account-type>\\n        <bank-name>Leumi</bank-name>\\n        <bank-id>12445</bank-id>\\n        <country>US</country>\\n        <city>Portland</city>\\n        <address>1 bank address</address>\\n        <state>MA</state>\\n        <zip>12345</zip>\\n        <bank-account-id>36628822</bank-account-id>\\n    </payout-info>\\n    <vendor-agreement>\\n        <commission-percent>20</commission-percent>\\n        <account-status>ACTIVE</account-status>\\n        <recurring-commission>Y</recurring-commission>\\n    </vendor-agreement>\\n</vendor>'\",\n      \"language\": \"curl\",\n      \"name\": \"Update Vendor: with commission percent\"\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>vendor&#x40;bluesnap.com</email>\\n    <name>Important Vendor</name>\\n    <first-name>Joe</first-name>\\n    <last-name>Smith</last-name>\\n    <address>123 Main Street</address>\\n    <city>testing city</city>\\n    <zip>4640802</zip>\\n    <country>us</country>\\n    <phone>0549766778</phone>\\n    <state>MA</state>\\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>Juneau</city>\\n        <zip>12345</zip>\\n        <country>US</country>\\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    <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-class>PERSONAL</bank-account-class>\\n        <bank-account-type>CHECKING</bank-account-type>\\n        <bank-name>Leumi</bank-name>\\n        <bank-id>12445</bank-id>\\n        <country>US</country>\\n        <city>Portland</city>\\n        <address>1 bank address</address>\\n        <state>MA</state>\\n        <zip>12345</zip>\\n        <bank-account-id>36628822</bank-account-id>\\n    </payout-info>\\n    <vendor-agreement>\\n        <commission-percent>20</commission-percent>\\n        <account-status>INACTIVE</account-status>\\n        <recurring-commission>Y</recurring-commission>\\n    </vendor-agreement>\\n</vendor>'\",\n      \"language\": \"curl\",\n      \"name\": \"with account status\"\n    }\n  ]\n}\n[/block]\n#Response Example\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"HTTP/ 1.1 204 No Content\",\n      \"language\": \"xml\",\n      \"name\": \"Update Vendor Response: 204 No Content\"\n    }\n  ]\n}\n[/block]\n##Example Descriptions\n\n###Update Vendor with commission percent\nThis example shows an Update Vendor request where commission percent has been modified by including `commission-percent` in `vendor-agreement`. For all future transactions, the transaction will be split according to the defined commission rate (unless overridden for a specific transaction). \n\n###Update Vendor with account status \nThis example show an Update Vendor request where account status has been switched to inactive by including `account-status` in `vendor-agreement`.","excerpt":"","slug":"update-vendor","type":"put","title":"Update Vendor"}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

vendor-id:
required
integer
BlueSnap identifier for the vendor

Documentation

The Update Vendor request enables you to change any of the following properties for an existing vendor:

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

Note: Modifying certain vendor properties may result in vendor payout suspension. Click here to learn more.

Important

  • It is suggested that you first retrieve the vendor and then modify the desired property.

  • To be eligible for payout, make sure all necessary vendor information has been submitted to BlueSnap. To see the payout requirements, click here.

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   required if payout-info included and 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 204 No Content

Request Example

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>vendor&#x40;bluesnap.com</email>
    <name>Important Vendor</name>
    <first-name>Joe</first-name>
    <last-name>Smith</last-name>
    <address>123 Main Street</address>
    <city>testing city</city>
    <zip>4640802</zip>
    <country>us</country>
    <phone>0549766778</phone>
    <state>MA</state>
    <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>Juneau</city>
        <zip>12345</zip>
        <country>US</country>
        <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>
    <payout-info>
        <payout-type>ACH</payout-type>
        <base-currency>USD</base-currency>
        <name-on-account>vendor</name-on-account>
        <bank-account-class>PERSONAL</bank-account-class>
        <bank-account-type>CHECKING</bank-account-type>
        <bank-name>Leumi</bank-name>
        <bank-id>12445</bank-id>
        <country>US</country>
        <city>Portland</city>
        <address>1 bank address</address>
        <state>MA</state>
        <zip>12345</zip>
        <bank-account-id>36628822</bank-account-id>
    </payout-info>
    <vendor-agreement>
        <commission-percent>20</commission-percent>
        <account-status>ACTIVE</account-status>
        <recurring-commission>Y</recurring-commission>
    </vendor-agreement>
</vendor>'
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>vendor&#x40;bluesnap.com</email>
    <name>Important Vendor</name>
    <first-name>Joe</first-name>
    <last-name>Smith</last-name>
    <address>123 Main Street</address>
    <city>testing city</city>
    <zip>4640802</zip>
    <country>us</country>
    <phone>0549766778</phone>
    <state>MA</state>
    <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>Juneau</city>
        <zip>12345</zip>
        <country>US</country>
        <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>
    <payout-info>
        <payout-type>ACH</payout-type>
        <base-currency>USD</base-currency>
        <name-on-account>vendor</name-on-account>
        <bank-account-class>PERSONAL</bank-account-class>
        <bank-account-type>CHECKING</bank-account-type>
        <bank-name>Leumi</bank-name>
        <bank-id>12445</bank-id>
        <country>US</country>
        <city>Portland</city>
        <address>1 bank address</address>
        <state>MA</state>
        <zip>12345</zip>
        <bank-account-id>36628822</bank-account-id>
    </payout-info>
    <vendor-agreement>
        <commission-percent>20</commission-percent>
        <account-status>INACTIVE</account-status>
        <recurring-commission>Y</recurring-commission>
    </vendor-agreement>
</vendor>'

Response Example

HTTP/ 1.1 204 No Content

Example Descriptions

Update Vendor with commission percent

This example shows an Update Vendor request where commission percent has been modified by including commission-percent in vendor-agreement. For all future transactions, the transaction will be split according to the defined commission rate (unless overridden for a specific transaction).

Update Vendor with account status

This example show an Update Vendor request where account status has been switched to inactive by including account-status in vendor-agreement.


User Information

Try It Out


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