Get Vendor
Retrieves a vendor’s details.
Authorizations
Most endpoints require an organization
token. Some endpoints require an application
token, and those endpoints are noted.
Path Parameters
Vendor ID.
Response
Custom number identifying the vendor. Must be unique in paypoint.
"1234"
Primary name for vendor.
"Herman's Coatings"
Secondary name for vendor.
"Herman's Coating Supply Company, LLC"
Business EIN or tax ID. This value is masked in API responses, for example XXXX6789
.
"123456789"
Vendor's phone number.
"212-555-1234"
Vendor's email address.
320
"example@email.com"
Vendor's address.
"123 Ocean Drive"
Additional line for vendor's address.
"Suite 400"
Vendor's city.
"Bristol"
Vendor's state.
"GA"
Vendor's zip code.
"31113"
Vendor's country.
"US"
Business Merchant Category Code (MCC). This resource lists MCC codes.
"7777"
Additional location code used to identify the vendor.
"LOC123"
List of contacts.
Object containing details about the payment method to use for the payout.
Vendor's status. Allowed status:
-
0 Inactive
-
1 Active
1
Payabli identifier for vendor record.
"1340"
Enrollment status of vendor in payables program.
null
Business legal name.
"Sunshine Services, LLC"
The alternate or common name that this business is doing business under usually referred to as a DBA name.
"Sunshine Gutters"
The entrypoint identifier.
50
"d193cf9a46"
The name of the parent organization.
"PropertyManager Pro"
Timestamp of when record was created, in UTC.
"2022-07-01 15:00:01"
Timestamp of when record was last updated, in UTC.
"2022-07-01 15:00:01"
Remittance address. Used for mailing paper checks.
"123 Walnut Street"
Remittance address additional line. Used for mailing paper checks.
"Suite 900"
Remittance address city. Used for mailing paper checks.
"Miami"
Remittance address state. Used for mailing paper checks.
"FL"
Remittance address ZIP code. Used for mailing paper checks.
"31113"
Remittance address country. Used for mailing paper checks.
"US"
Alternative name used to receive paper check.
Alternative name used to receive paper check.
Account number of paypoint in the vendor system.
"123-456"
Internal identifier for global vendor account.
Custom dictionary of key:value pairs. You can use this field to store any data related to the object or for your system. Example usage:
{
"additionalData": {
"key1": "value1",
"key2": "value2",
"key3": "value3"
}
}
{
"key1": "value1",
"key2": "value2",
"key3": "value3"
}
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.
"Paypoint-100"
Was this page helpful?