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

Authorizations

requestToken
string
header
required

Most endpoints require an organization token. Some endpoints require an application token, and those endpoints are noted.

Path Parameters

idVendor
integer
required

Vendor ID.

Response

200 - application/json
Success
vendorNumber
string | null

Custom number identifying the vendor. Must be unique in paypoint.

Example:

"1234"

name1
string | null

Primary name for vendor.

Example:

"Herman's Coatings"

name2
string | null

Secondary name for vendor.

Example:

"Herman's Coating Supply Company, LLC"

ein
string | null

Business EIN or tax ID. This value is masked in API responses, for example XXXX6789.

Example:

"123456789"

phone
string | null

Vendor's phone number.

Example:

"212-555-1234"

email
string | null

Vendor's email address.

Maximum length: 320
Example:

"example@email.com"

address1
string | null

Vendor's address.

Example:

"123 Ocean Drive"

address2
string | null

Additional line for vendor's address.

Example:

"Suite 400"

city
string | null

Vendor's city.

Example:

"Bristol"

state
string | null

Vendor's state.

Example:

"GA"

zip
string | null

Vendor's zip code.

Example:

"31113"

country
string | null

Vendor's country.

Example:

"US"

mcc
string | null

Business Merchant Category Code (MCC). This resource lists MCC codes.

Example:

"7777"

locationCode
string | null

Additional location code used to identify the vendor.

Example:

"LOC123"

contacts
object[] | null

List of contacts.

billingData
object
paymentMethod
object

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

vendorStatus
integer | null

Vendor's status. Allowed status:

  • 0 Inactive

  • 1 Active

Example:

1

vendorId
integer | null

Payabli identifier for vendor record.

Example:

"1340"

enrollmentStatus
string | null

Enrollment status of vendor in payables program.

Example:

null

summary
object
paypointLegalname
string | null

Business legal name.

Example:

"Sunshine Services, LLC"

paypointDbaname
string | null

The alternate or common name that this business is doing business under usually referred to as a DBA name.

Example:

"Sunshine Gutters"

paypointEntryname
string | null

The entrypoint identifier.

Maximum length: 50
Example:

"d193cf9a46"

parentOrgName
string | null

The name of the parent organization.

Example:

"PropertyManager Pro"

createdDate
string

Timestamp of when record was created, in UTC.

Example:

"2022-07-01 15:00:01"

lastUpdated
string | null

Timestamp of when record was last updated, in UTC.

Example:

"2022-07-01 15:00:01"

remitAddress1
string | null

Remittance address. Used for mailing paper checks.

Example:

"123 Walnut Street"

remitAddress2
string | null

Remittance address additional line. Used for mailing paper checks.

Example:

"Suite 900"

remitCity
string | null

Remittance address city. Used for mailing paper checks.

Example:

"Miami"

remitState
string | null

Remittance address state. Used for mailing paper checks.

Example:

"FL"

remitZip
string | null

Remittance address ZIP code. Used for mailing paper checks.

Example:

"31113"

remitCountry
string | null

Remittance address country. Used for mailing paper checks.

Example:

"US"

payeeName1
string | null

Alternative name used to receive paper check.

payeeName2
string | null

Alternative name used to receive paper check.

customerVendorAccount
string | null

Account number of paypoint in the vendor system.

Example:

"123-456"

internalReferenceId
integer | null

Internal identifier for global vendor account.

additionalData
object

Custom dictionary of key:value pairs. You can use this field to store any data related to the object or for your system. Example usage:

{
  "additionalData": {
    "key1": "value1",
    "key2": "value2",
    "key3": "value3"
  }
}
Example:
{
  "key1": "value1",
  "key2": "value2",
  "key3": "value3"
}
externalPaypointId
string | null

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.

Example:

"Paypoint-100"

Was this page helpful?