Retrieve Vendor

The Retrieve Vendor request enables you to retrieve details about one existing vendor.


❗️

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

Enter the vendor-id into the web service URL, in the format:
services/2/vendors/{vendor-id}

For example:
services/2/vendors/2111111

Response Details

If successful, the response HTTP status code is 200 OK.
The response contains the retrieved vendor-info.


Examples

Request Examples

curl -v -X GET https://sandbox.bluesnap.com/services/2/vendors/837429 \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='

Response Examples

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<vendor xmlns="http://ws.plimus.com">
  <vendor-id>837429</vendor-id>
  <email>vendor&#x40;bluesnap.com</email>
  <name>Important Vendor</name>
  <ipn-url>https&#x3a;&#x2f;&#x2f;merchant-domain.com&#x2f;ipn</ipn-url>
  <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>
  <frequency>MONTHLY</frequency>
  <delay>15</delay>
  <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&#x40;vendor.com</email>
  </vendor-principal>
  <payout-info>
    <payout-type>ACH</payout-type>
    <base-currency>USD</base-currency>
    <minimal-payout-amount>25</minimal-payout-amount>
    <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>
    <intermediary-bank-info />
    <payment-reference>Payment for vendor 1234</payment-reference>
  </payout-info>
  <vendor-agreement>
    <commission-percent>20</commission-percent>
    <account-status>INACTIVE</account-status>
    <recurring-commission>Y</recurring-commission>
  </vendor-agreement>
  <verification>
    <payout-status>Approved</payout-status>
    <processing-status>Inactive</processing-status>
  </verification>
</vendor>

Back to Top


API Explorer (for request based on Vendor ID)

To test out a call, enter an existing vendor ID (e.g 837429) in the vendor-id field.

Language
Authorization
Header
Click Try It! to start a request and see the response here!