put https://sandbox.bluesnap.com/services/2/vendors/:vendor-id
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 URL
- 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
We recommend 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.
Important
The API Explorer Try It! feature does not currently send XML requests to our sandbox environment.
For request and response examples, refer to the Examples section.
Request Content
vendor container required, contains the following properties (see vendor):
| Property | Type | Required |
|---|---|---|
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 |
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) |
Response Details
If successful, the response HTTP status code is 204 No Content
Examples
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@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>
<vendor-url>http://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>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>[email protected]</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>123456789</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>
<minimal-payout-amount>25</minimal-payout-amount>
<payment-reference>Payment for vendor 1234</payment-reference>
<refund-reserve>200</refund-reserve>
</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@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>
<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>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>[email protected]</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>123456789</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>
<minimal-payout-amount>25</minimal-payout-amount>
<payment-reference>Payment for vendor 1234</payment-reference>
<refund-reserve>200</refund-reserve>
</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
API Explorer
To test out a call, enter an existing vendor ID, such as 837429, into the vendor-id field below. The ID will automatically be inserted into the URL. Click Try it! when you're ready to test the call.