> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://beta-docs.payabli.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://beta-docs.payabli.com/_mcp/server.

# Get vendor

GET https://api-sandbox.payabli.com/api/Vendor/{idVendor}

Retrieves a vendor's details. 

Reference: https://beta-docs.payabli.com/api-reference/vendor/get-vendor

## Authentication

- `requestToken` header (required) — API Key authentication via header

## Servers

- `https://api-sandbox.payabli.com/api` (Sandbox, default)
- `https://api.payabli.com/api` (Production)

## Request

### Path parameters

- `idVendor` (integer, required) — Vendor ID.

## Response

### 200

Success

- `additionalData` (map from string to map from string to any, optional) — Custom dictionary of key:value pairs. You can use this field to store any data related to the object or for your system. If you are using [custom identifiers](/developer-guides/entities-custom-identifiers), pass those in this object. Example usage: ```json { "additionalData": { "key1": "value1", "key2": "value2", "key3": "value3" } } ```
- `address1` (string, optional) — Vendor's address.
- `address2` (string, optional) — Additional line for vendor's address.
- `billingData` (BillingDataResponse, optional)
- `city` (string, optional) — Vendor's city.
- `contacts` (list of Contacts, optional) — List of contacts.
- `country` (string, optional) — Vendor's country.
- `createdDate` (datetime, optional) — Timestamp of when record was created, in UTC.
- `customerVendorAccount` (string, optional) — Account number of paypoint in the vendor system.
- `ein` (string, optional) — Business EIN or tax ID. This value is masked in API responses, for example `XXXX6789`.
- `email` (string, optional) — Vendor's email address.
- `enrollmentStatus` (string, optional) — Enrollment status of vendor in payables program.
- `externalPaypointId` (string, optional) — A custom identifier for the paypoint, if applicable. Like `entrypoint` is the Payabli identifier for the merchant, `externalPaypointId` is a custom field you can use to include the merchant's ID from your own systems.
- `internalReferenceId` (long, optional) — Internal identifier for global vendor account.
- `lastUpdated` (datetime, optional) — Timestamp of when record was last updated, in UTC.
- `locationCode` (string, optional) — Additional location code used to identify the vendor.
- `mcc` (string, optional) — Business Merchant Category Code (MCC). [This resource](https://github.com/greggles/mcc-codes/blob/main/mcc_codes.csv) lists MCC codes.
- `name1` (string, optional) — Primary name for vendor.
- `name2` (string, optional) — Secondary name for vendor.
- `parentOrgName` (string, optional) — The name of the parent organization.
- `payeeName1` (string, optional) — Alternative name used to receive paper check.
- `payeeName2` (string, optional) — Alternative name used to receive paper check.
- `paymentMethod` (VendorPaymentMethod, optional) — Object containing details about the payment method to use for the payout.
- `paypointDbaname` (string, optional) — The alternate or common name that this business is doing business under usually referred to as a DBA name.
- `paypointEntryname` (string, optional) — The entrypoint identifier.
- `paypointLegalname` (string, optional) — Business legal name.
- `phone` (string, optional) — Vendor's phone number.
- `remitAddress1` (string, optional) — Remittance address. Used for mailing paper checks.
- `remitAddress2` (string, optional) — Remittance address additional line. Used for mailing paper checks.
- `remitCity` (string, optional) — Remittance address city. Used for mailing paper checks.
- `remitCountry` (string, optional) — Remittance address country. Used for mailing paper checks.
- `remitState` (string, optional) — Remittance address state. Used for mailing paper checks.
- `remitZip` (string, optional) — Remittance address ZIP code. Used for mailing paper checks.
- `state` (string, optional) — Vendor's state.
- `summary` (VendorSummary, optional)
- `vendorId` (integer, optional) — Payabli identifier for vendor record.
- `vendorNumber` (string, optional) — Custom number identifying the vendor. Must be unique in paypoint.
- `vendorStatus` (integer, optional) — Vendor's status. Allowed status: - 0 Inactive - 1 Active
- `zip` (string, optional) — Vendor's zip code.

## Errors

### 400 Bad Request Error

Bad request/ invalid data

- `any`

### 401 Unauthorized Error

Unauthorized request.

- `any`

### 500 Internal Server Error

Internal API Error

- `any`

### 503 Service Unavailable Error

Database connection error

- `isSuccess` (boolean, optional) — Boolean indicating whether the operation was successful. A `true` value indicates success. A `false` value indicates failure.
- `responseData` (map from string to any, optional) — The object containing the response data.
- `responseText` (string, optional) — Response text for operation: 'Success' or 'Declined'.

## Types

### BillingDataResponse

- `accountNumber` (string, optional) — Masked account number for bank account.
- `bankAccountFunction` (integer, optional) — Describes whether the bank account is used for deposits or withdrawals in Payabli: - `0`: Deposit - `1`: Withdrawal - `2`: Deposit and withdrawal
- `bankAccountHolderName` (string, optional) — The accountholder's name.
- `bankAccountHolderType` (enum, optional) — Describes whether the bank is a personal or business account.
  - Allowed values: `Personal`, `Business`
- `bankName` (string, optional) — Name of bank for account.
- `id` (integer, optional) — The bank's ID in Payabli.
- `routingAccount` (string, optional) — Routing number of bank account.
- `typeAccount` (enum, optional) — Type of bank account: Checking or Savings.
  - Allowed values: `Checking`, `Savings`

### Contacts

- `contactEmail` (string, optional) — Contact email address.
- `contactName` (string, optional) — Contact name.
- `contactPhone` (string, optional) — Contact phone number.
- `contactTitle` (string, optional) — Contact title.

### VendorPaymentMethod

Object containing details about the payment method to use for the payout.

- `method` (enum, optional) — Payment method to use for payout. Leave empty for managed payables.
  - Allowed values: `managed`, `vcard`, `ach`, `check`

### VendorSummary

- `inTransitBills` (integer, optional)
- `inTransitBillsAmount` (double, optional)
- `overdueBills` (integer, optional)
- `overdueBillsAmount` (double, optional)
- `paidBills` (integer, optional)
- `paidBillsAmount` (double, optional)
- `pendingBills` (integer, optional)
- `pendingBillsAmount` (double, optional)
- `totalBills` (integer, optional)
- `totalBillsAmount` (double, optional)

## Examples

**Response**

```json
{
  "additionalData": {
    "key1": {
      "key": "value"
    },
    "key2": {
      "key": "value"
    },
    "key3": {
      "key": "value"
    }
  },
  "address1": "123 Ocean Drive",
  "address2": "Suite 400",
  "billingData": {
    "accountNumber": "1XXXXXX3123",
    "bankAccountFunction": 0,
    "bankAccountHolderName": "Gruzya Adventure Outfitters LLC",
    "bankAccountHolderType": "Personal",
    "bankName": "Country Bank",
    "id": 1,
    "routingAccount": "123123123",
    "typeAccount": "Checking"
  },
  "city": "Bristol",
  "contacts": [
    {
      "contactEmail": "example@email.com",
      "contactName": "Herman Martinez",
      "contactPhone": "3055550000",
      "contactTitle": "Owner"
    }
  ],
  "country": "US",
  "createdDate": "2022-07-01T15:00:01Z",
  "customerVendorAccount": "123-456",
  "ein": "123456789",
  "email": "example@email.com",
  "enrollmentStatus": "enrollmentStatus",
  "externalPaypointId": "Paypoint-100",
  "internalReferenceId": 1000000,
  "lastUpdated": "2022-07-01T15:00:01Z",
  "locationCode": "LOC123",
  "mcc": "7777",
  "name1": "Herman's Coatings",
  "name2": "Herman's Coating Supply Company, LLC",
  "parentOrgName": "PropertyManager Pro",
  "payeeName1": "payeeName1",
  "payeeName2": "payeeName2",
  "paymentMethod": {
    "method": "managed"
  },
  "paypointDbaname": "Sunshine Gutters",
  "paypointEntryname": "d193cf9a46",
  "paypointLegalname": "Sunshine Services, LLC",
  "phone": "212-555-1234",
  "remitAddress1": "123 Walnut Street",
  "remitAddress2": "Suite 900",
  "remitCity": "Miami",
  "remitCountry": "US",
  "remitState": "FL",
  "remitZip": "31113",
  "state": "GA",
  "summary": {
    "inTransitBills": 1,
    "inTransitBillsAmount": 1.1,
    "overdueBills": 1,
    "overdueBillsAmount": 1.1,
    "paidBills": 1,
    "paidBillsAmount": 1.1,
    "pendingBills": 1,
    "pendingBillsAmount": 1.1,
    "totalBills": 1,
    "totalBillsAmount": 1.1
  },
  "vendorId": 1,
  "vendorNumber": "1234",
  "vendorStatus": 1,
  "zip": "31113"
}
```

**SDK Code**

```python
import requests

url = "https://api-sandbox.payabli.com/api/Vendor/1"

headers = {"requestToken": "<apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api-sandbox.payabli.com/api/Vendor/1';
const options = {method: 'GET', headers: {requestToken: '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.payabli.com/api/Vendor/1"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("requestToken", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api-sandbox.payabli.com/api/Vendor/1")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["requestToken"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api-sandbox.payabli.com/api/Vendor/1")
  .header("requestToken", "<apiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api-sandbox.payabli.com/api/Vendor/1', [
  'headers' => [
    'requestToken' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api-sandbox.payabli.com/api/Vendor/1");
var request = new RestRequest(Method.GET);
request.AddHeader("requestToken", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["requestToken": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api-sandbox.payabli.com/api/Vendor/1")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```