API referencePay Out endpointsVendor

Get vendor

Retrieves a vendor's details.

Authentication

requestTokenstring
API Key authentication via header

Path parameters

idVendorintegerRequired
Vendor ID.

Response

Success
additionalDatamap from strings to optional maps from strings to any

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
Vendor's address.
address2string
Additional line for vendor's address.
billingDataobject
citystring
Vendor's city.
contactslist of objects
List of contacts.
countrystring
Vendor's country.
createdDatedatetime
Timestamp of when record was created, in UTC.
customerVendorAccountstring
Account number of paypoint in the vendor system.
einstring

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

emailstringformat: "email"<=320 characters
Vendor's email address.
enrollmentStatusstring
Enrollment status of vendor in payables program.
externalPaypointIdstring

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
Internal identifier for global vendor account.
lastUpdateddatetime
Timestamp of when record was last updated, in UTC.
locationCodestring
Additional location code used to identify the vendor.
mccstring

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

name1string
Primary name for vendor.
name2string
Secondary name for vendor.
parentOrgNamestring
The name of the parent organization.
payeeName1string
Alternative name used to receive paper check.
payeeName2string
Alternative name used to receive paper check.
paymentMethodobject
Object containing details about the payment method to use for the payout.
paypointDbanamestring
The alternate or common name that this business is doing business under usually referred to as a DBA name.
paypointEntrynamestring<=50 characters
The entrypoint identifier.
paypointLegalnamestring
Business legal name.
phonestring
Vendor's phone number.
remitAddress1string
Remittance address. Used for mailing paper checks.
remitAddress2string
Remittance address additional line. Used for mailing paper checks.
remitCitystring
Remittance address city. Used for mailing paper checks.
remitCountrystring
Remittance address country. Used for mailing paper checks.
remitStatestring
Remittance address state. Used for mailing paper checks.
remitZipstring
Remittance address ZIP code. Used for mailing paper checks.
statestring
Vendor's state.
summaryobject
vendorIdinteger
Payabli identifier for vendor record.
vendorNumberstring
Custom number identifying the vendor. Must be unique in paypoint.
vendorStatusinteger

Vendor’s status. Allowed status:

  • 0 Inactive

  • 1 Active

zipstring
Vendor's zip code.

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error
503
Service Unavailable Error