Retrieve Vendor

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


📘

Tip

You can test out a request that hits our sandbox in real-time. Follow the instructions here to use the "Try It!" feature on the right side.

Request Content

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

For example: services/2/vendors/2111111

Response Details

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


Examples

Request Examples

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

Response Examples

{
  "vendorId": 837389,
  "email": "[email protected]",
  "name": "Default Vendor",
  "ipnUrl": "https://ipnaddress.com",
  "firstName": "Joe",
  "lastName": "Smith",
  "address": "123 Main Street",
  "city": "Boston",
  "zip": "02453",
  "country": "us",
  "phone": "1-123-456-7890",
  "state": "MA",
  "defaultPayoutCurrency": "USD",
  "frequency": "MONTHLY",
  "delay": 15,
  "vendorPrincipal": {
    "firstName": "Joe",
    "lastName": "Smith",
    "address": "123 Main Street",
    "city": "Boston",
    "zip": "02453",
    "country": "US",
    "dob": "28-09-9999",
    "personalIdentificationNumber": "1234",
    "driverLicenseNumber": "561196411",
    "email": "[email protected]"
  },
  "payoutInfo": [
    {
      "payoutType": "ACH",
      "baseCurrency": "USD",
      "refundReserve": 200,
      "minimalPayoutAmount": "50",
      "nameOnAccount": "vendor",
      "bankAccountClass": "PERSONAL",
      "bankAccountType": "CHECKING",
      "bankName": "Leumi",
      "bankId": "123456789",
      "country": "us",
      "city": "Juneau",
      "address": "1 bank address",
      "state": "MA",
      "zip": "02453",
      "bankAccountId": "36628822",
      "intermediaryBankInfo": {},
      "paymentReference": "Payment for vendor 1234"
    }
  ],
  "vendorAgreement": {
    "commissionPercent": 30,
    "accountStatus": "ACTIVE",
    "recurringCommission": "Y"
  },
  "verification": {
    "payoutStatus": "Approved",
    "processingStatus": "Active"
  }
}

Back to Top


API Explorer (for request based on vendorId)

To test out a call, enter an existing vendor ID (e.g 837389) in the vendorId field. This will automatically insert the ID into the request URL.

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