API referencePay Out endpointsVendor

Get vendor

Retrieves a vendor's details.

Path parameters

idVendorintegerRequired
Vendor ID.

Headers

requestTokenstringRequired

Response

Success
additionalDatamap from strings to optional maps from strings to any or null

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, pass those in this object. Example usage:

1{
2  "additionalData": {
3    "key1": "value1",
4    "key2": "value2",
5    "key3": "value3"
6  }
7}
Address1string or null
The address.
Address2string or null
Additional line for the address.
BillingDataobject or null
Citystring or null
The city.
Contactsobject or null
Countrystring or null
CreatedDatedatetime or null
Timestamp of when record was created, in UTC.
customerVendorAccountstring or null
customField1string or null
customField2string or null
EINstring or null

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

Emailstring or nullformat: "email"<=320 characters
Email address.
EnrollmentStatusstring or null
Enrollment status of vendor in payables program.
externalPaypointIDstring or 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.

InternalReferenceIdlong or null
Internal identifier for global vendor account.
LastUpdateddatetime or null
Timestamp of when record was last updated, in UTC.
LocationCodestring or null
Mccstring or null

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

Name1string or null
Name2string or null
ParentOrgNamestring or null
The name of the parent organization.
ParentOrgIdlong or null
The ID of the org's parent organization.
payeeName1string or null
Alternative name used to receive paper check.
payeeName2string or null
Alternative name used to receive paper check.
PaymentMethodstring or null

The vendor’s preferred payment method. Can be one of:

  • "managed" - Managed payment method
  • "vcard" - Virtual card payment method
  • "check" - Check payment method
  • "ach" - ACH payment method
PaypointDbanamestring or null
The alternate or common name that this business is doing business under usually referred to as a DBA name.
PaypointEntrynamestring or null<=50 characters
The entrypoint identifier.
PaypointLegalnamestring or null
Business legal name.
Phonestring or null
remitAddress1string or null
Remittance address. Used for mailing paper checks.
remitAddress2string or null
Remittance address additional line. Used for mailing paper checks.
remitCitystring or null
Remittance address city. Used for mailing paper checks.
remitCountrystring or null
Remittance address country. Used for mailing paper checks.
RemitEmailstring or nullformat: "email"
Remittance email address. Used for sending virtual cards and other information about payouts.
remitStatestring or null
Remittance address state. Used for mailing paper checks.
remitZipstring or null
Remittance address ZIP code. Used for mailing paper checks.
Statestring or null
The state or province.
StoredMethodslist of objects or null
Summaryobject or null
VendorIdinteger or null
Payabli identifier for vendor record.
VendorNumberstring or null
Custom number identifying the vendor. Must be unique in paypoint.
VendorStatusinteger or null

Vendor’s status. Allowed status:

  • 0 Inactive

  • 1 Active

Zipstring or null
ZIP code for address.

Errors