APIPay Out endpointsVendor

Get vendor

View as MarkdownOpen in Claude
Retrieves a vendor's details, including enrichment status and payment acceptance info when available.

Authentication

requestTokenstring

Long-lived API token sent in the requestToken header. See API token authentication.

OR
AuthorizationBearer

OAuth2 Bearer access token from the client-credentials flow. See OAuth authentication.

Path parameters

idVendorintegerRequired
Vendor ID.

Response

Success
VendorNumberstring
Custom number identifying the vendor. Must be unique in paypoint. Can't be blank.
Name1string
Name2string or null
EINstring or null
Business EIN or tax ID. This value is masked in API responses.
Phonestring
Emailstringformat: "email"<=320 characters
Email address.
RemitEmailstring or nullformat: "email"
Remittance email address. Used for sending virtual cards and other information about payouts.
Address1string
The address.
Address2string
Additional line for the address.
Citystring
The city.
Statestring
The state or province.
Zipstring
ZIP code for address.
Countrystring
Mccstring

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

LocationCodestring
Contactslist of objects
Array of objects describing the vendor's contacts.
BillingDataobject
PaymentMethodstring

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
VendorStatusinteger

Vendor’s status. Allowed values:

  • 0 Inactive
  • 1 Active
  • -99 Deleted
VendorIdinteger
Payabli identifier for vendor record.
EnrollmentStatusstring
Enrollment status of vendor in payables program.
Summaryobject
PaypointLegalnamestring
Business legal name.
PaypointIdlong or null
The paypoint's ID. This is different from the entryname.
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.
ParentOrgNamestring
The name of the parent organization.
ParentOrgIdlong
The ID of the org's parent organization.
CreatedDatedatetime
Timestamp of when record was created, in UTC.
LastUpdateddatetime
Timestamp of when record was last updated, in UTC.
remitAddress1string
Remittance street address. Used for mailing paper checks. Required if any remittance address field is provided.
remitAddress2string
Remittance address additional line, such as a suite or unit number. Used for mailing paper checks. Always optional.
remitCitystring
Remittance address city. Used for mailing paper checks. Required if any remittance address field is provided.
remitStatestring
Remittance address state or province. Used for mailing paper checks. Required if any remittance address field is provided. Must be a valid US state or Canadian province abbreviation.
remitZipstring

Remittance address ZIP or postal code. Used for mailing paper checks. Required if any remittance address field is provided. For US addresses, use five digits or ZIP+4 format.

remitCountrystring

Remittance address country. Used for mailing paper checks. Must be US or CA. Defaults to US if not provided.

payeeName1string
Alternative name used to receive paper check.
payeeName2string
Alternative name used to receive paper check.
customField1string
customField2string
customerVendorAccountstring
InternalReferenceIdlong
An internal reference ID.
PaymentPortalUrlstring
URL for the vendor's online payment portal, if known. Populated by the vendor enrichment pipeline.
CardAcceptedstring

Whether the vendor accepts card payments. Values are yes, no, or unable to determine. Populated by the vendor enrichment pipeline.

AchAcceptedstring

Whether the vendor accepts ACH payments. Values are yes, no, or unable to determine. Populated by the vendor enrichment pipeline.

CheckAcceptedstring

Whether the vendor accepts check payments. Values are yes, no, or unable to determine. Populated by the vendor enrichment pipeline.

EnrichmentStatusstring

Current enrichment state of the vendor. Values are not_enriched, partially_enriched, fully_enriched, or fallback_applied.

EnrichedBystring

Which enrichment method resolved the vendor’s payment acceptance info. Values are invoice_scan, web_search, vendor_network, or manual.

EnrichedAtdatetime

When the vendor was last enriched (UTC).

EnrichmentIdstring
Identifier for the enrichment request that last updated this vendor.
additionalDatamap from strings to 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. Max length for a value is 100 characters. Example usage:

1{
2  "additionalData": {
3    "key1": "value1",
4    "key2": "value2",
5    "key3": "value3"
6  }
7}
externalPaypointIDstring
A custom identifier for the paypoint, if applicable.
StoredMethodslist of objects