GET
/
Vendor
/
{idVendor}

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
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"
  }
}
address1
string | null

Vendor's address.

address2
string | null

Additional line for vendor's address.

billingData
object
city
string | null

Vendor's city.

contacts
object[] | null

List of contacts.

country
string | null

Vendor's country.

createdDate
string

Timestamp of when record was created, in UTC.

customerVendorAccount
string | null

Account number of paypoint in the vendor system.

ein
string | null

Business EIN or tax ID.

email
string | null

Vendor's email address.

enrollmentStatus
string | null

Enrollment status of vendor in payables program.

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.

internalReferenceId
integer | null

Internal identifier for global vendor account.

lastUpdated
string | null

Timestamp of when record was last updated, in UTC.

locationCode
string | null

Additional location code used to identify the vendor.

mcc
string | null

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

name1
string | null

Primary name for vendor.

name2
string | null

Secondary name for vendor.

parentOrgName
string | null

The name of the parent organization.

payeeName1
string | null

Alternative name used to receive paper check.

payeeName2
string | null

Alternative name used to receive paper check.

paymentMethod
object

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

paypointDbaname
string | null

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

paypointEntryname
string | null

The entrypoint identifier.

Maximum length: 50
paypointLegalname
string | null

Business legal name.

phone
string | null

Vendor's phone number.

remitAddress1
string | null

Remittance address. Used for mailing paper checks.

remitAddress2
string | null

Remittance address additional line. Used for mailing paper checks.

remitCity
string | null

Remittance address city. Used for mailing paper checks.

remitCountry
string | null

Remittance address country. Used for mailing paper checks.

remitState
string | null

Remittance address state. Used for mailing paper checks.

remitZip
string | null

Remittance address ZIP code. Used for mailing paper checks.

state
string | null

Vendor's state.

summary
object
vendorId
integer | null

Payabli identifier for vendor record.

vendorNumber
string | null

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

vendorStatus
integer | null

Vendor's status. Allowed status:

  • 0 Inactive

  • 1 Active

zip
string | null

Vendor's zip code.