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

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

emailstring or nullformat: "email"<=320 characters
Vendor's 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
Additional location code used to identify the vendor.
mccstring or null

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

name1string or null
Primary name for vendor.
name2string or null
Secondary name for vendor.
parentOrgNamestring or null
The name of the parent organization.
payeeName1string or null
Alternative name used to receive paper check.
payeeName2string or null
Alternative name used to receive paper check.
paymentMethodobject or null
Object containing details about the payment method to use for the payout.
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
Vendor's phone number.
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.
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
Vendor's state.
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
Vendor's zip code.

Errors