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 anyOptional

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}
address1stringOptional

Vendor’s address.

address2stringOptional

Additional line for vendor’s address.

billingDataobjectOptional
citystringOptional

Vendor’s city.

contactslist of objectsOptional

List of contacts.

countrystringOptional

Vendor’s country.

createdDatedatetimeOptional

Timestamp of when record was created, in UTC.

customerVendorAccountstringOptional

Account number of paypoint in the vendor system.

einstringOptional

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

emailstringOptionalformat: "email"<=320 characters

Vendor’s email address.

enrollmentStatusstringOptional

Enrollment status of vendor in payables program.

externalPaypointIdstringOptional

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.

internalReferenceIdlongOptional

Internal identifier for global vendor account.

lastUpdateddatetimeOptional

Timestamp of when record was last updated, in UTC.

locationCodestringOptional

Additional location code used to identify the vendor.

mccstringOptional

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

name1stringOptional

Primary name for vendor.

name2stringOptional

Secondary name for vendor.

parentOrgNamestringOptional

The name of the parent organization.

payeeName1stringOptional

Alternative name used to receive paper check.

payeeName2stringOptional

Alternative name used to receive paper check.

paymentMethodobjectOptional

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

paypointDbanamestringOptional

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

paypointEntrynamestringOptional<=50 characters

The entrypoint identifier.

paypointLegalnamestringOptional

Business legal name.

phonestringOptional

Vendor’s phone number.

remitAddress1stringOptional

Remittance address. Used for mailing paper checks.

remitAddress2stringOptional

Remittance address additional line. Used for mailing paper checks.

remitCitystringOptional

Remittance address city. Used for mailing paper checks.

remitCountrystringOptional

Remittance address country. Used for mailing paper checks.

remitStatestringOptional

Remittance address state. Used for mailing paper checks.

remitZipstringOptional

Remittance address ZIP code. Used for mailing paper checks.

statestringOptional

Vendor’s state.

summaryobjectOptional
vendorIdintegerOptional

Payabli identifier for vendor record.

vendorNumberstringOptional

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

vendorStatusintegerOptional

Vendor’s status. Allowed status:

  • 0 Inactive

  • 1 Active

zipstringOptional

Vendor’s zip code.

Errors