Payabli Vendor API is one of 33 APIs that Payabli publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Vendor. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes
7 operations
across 5 paths,
and defines 78 schemas.
It is described by OpenAPI 3.1.0, at version 1.0.0.
Requests are made against 2 base URLs: https://api-sandbox.payabli.com/api, https://api.payabli.com/api.
The identity and technical contract details declared by the specification.
VendorCallStatusResponse
object
Latest AI outreach call activity for a vendor. The populated block depends on the state discriminator.
5 properties
VendorScheduleCallResponse
object
Response from the schedule outreach call endpoint.
6 properties
1 required
ContactsField
array
List of contacts.
AccountId
string
Custom identifier for payment connector.
BankName
string
Name of bank for account.
PayabliErrorBodyResponseData
object
Object with detailed error context.
2 properties
Email
string
Email address.
CityNullable
string
The city.
RoomIdNotInUse
integer
Field not in use on this endpoint. It always returns 0.
RemitEmail
string
Remittance email address. Used for sending virtual cards and other information about payouts.
PayeeName
string
Alternative name used to receive paper check.
Entrypointfield
string
The entrypoint identifier.
PayabliApiResponseVendors
object
5 properties
1 required
PageIdentifier
string
Auxiliary validation used internally by payment pages and components.
Vendorid
integer
Payabli identifier for vendor record.
FileContent
object
Contains details about a file. Max upload size is 30 MB.
4 properties
VendorData
object
34 properties
CreatedAt
string
Timestamp of when record was created, in UTC.
BinData
object
Object containing information related to the card. This object is null unless the payment method is card. If the payment method is Apple Pay, the binData will…
11 properties
VendorPhone
string
Vendor's phone number. Phone number can't contain non-digit characters like hyphens or parentheses.
ResponseText
string
Response text for operation: 'Success' or 'Declined'.
Remitcountry
string
Remittance address country. Used for mailing paper checks. Must be US or CA. Defaults to US if not provided.
EnrollmentStatus
string
Enrollment status of vendor in payables program.
InternalReferenceId
integer
An internal reference ID.
VendorName2
string
Secondary name for vendor. If provided, allowed characters are the same as the name1 field.
PayabliErrorBody
object
Shape returned by every Payabli API error response. The responseData object carries human-readable error context.
4 properties
2 required
VendorEnrichmentWebSearch
object
Vendor contact information and payment acceptance info found through web search.
15 properties
VendorCallStatusCompleted
object
Details of a completed outreach call that returned data.
6 properties
Vendorstatus
integer
Vendor's status. Allowed values: - 0 Inactive - 1 Active - -99 Deleted
BankAccountHolderType
string
Describes whether the bank is a personal or business account.
LocationCode
string
A location code used to identify the vendor's location.
AdditionalDataString
string
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: json { "additionalData"…
RoutingAccount
string
Routing number of bank account.
VendorEnrichmentData
object
Container for enrichment stage results.
2 properties
VendorEin
string
EIN/Tax ID for vendor. Must be nine digits formatted as XX-XXXXXXX (for example, 12-3456789).
IsSuccess
boolean
Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.
Ein
string
Business EIN or tax ID. This value is masked in API responses.
VendorCallStatusScheduled
object
Details of a queued or in-progress outreach call.
3 properties
Dbaname
string
The alternate or common name that this business is doing business under, usually referred to as a DBA name.
BillingDataResponse
object
14 properties
13 required
VendorQueryRecord
object
53 properties
VendorNumber
string
Custom number identifying the vendor. Must be unique in paypoint. Can't be blank.
VendorCallStatusExtractedData
object
Data extracted from a completed outreach call.
2 properties
Remitzip
string
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 o…
BankAccountHolderName
string
The accountholder's name.
VendorScheduleCallRequest
object
Request body for scheduling an AI outreach call to a vendor.
8 properties
1 required
ContactsResponse
object
4 properties
AdditionalDataMap
object
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](…
BillingData
object
8 properties
Remitaddress2
string
Remittance address additional line, such as a suite or unit number. Used for mailing paper checks. Always optional.
FileContentFtype
string
The MIME type of the file (if content is provided).
Mcc
string
Business Merchant Category Code (MCC). [This resource](https://github.com/greggles/mcc-codes/blob/main/mcccodes.csv) lists MCC codes.
OrgParentId
integer
The ID of the org's parent organization.
VendorPaymentMethodString
string
The vendor's preferred payment method. Can be one of: - managed — Managed payment method - vcard — Virtual card payment method - check — Check payment method -…
LastModified
string
Timestamp of when record was last updated, in UTC.
ExternalPaypointId
string
A custom identifier for the paypoint, if applicable.
VendorCallStatusFailed
object
Details of an outreach call that didn't complete successfully.
5 properties
Remitcity
string
Remittance address city. Used for mailing paper checks. Required if any remittance address field is provided.
Remitaddress1
string
Remittance street address. Used for mailing paper checks. Required if any remittance address field is provided.
VendorEnrichRequest
object
Request body for the vendor enrichment endpoint.
7 properties
1 required
VendorEnrichmentInvoiceScan
object
Vendor contact information and payment acceptance info extracted from an invoice.
15 properties
Contacts
object
5 properties
OrgParentName
string
The name of the parent organization.
VendorEnrichResponse
object
Response from the vendor enrichment endpoint.
6 properties
1 required
VendorName1
string
Primary name for vendor. Required for new vendor.
StateNullable
string
The state or province.
AddressNullable
string
The address.
VendorEnrichResponseData
object
Enrichment result details.
5 properties
Remitstate
string
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…
VendorResponseStoredMethod
object
Stored payment method information
17 properties
17 required
VendorSummary
object
16 properties
Zip
string
ZIP code for address.
VendorScheduleCallResponseData
object
Scheduled call details.
4 properties
TypeAccount
string
Type of bank account: Checking or Savings.
Responsecode
integer
Code for the response. Learn more in [API Response Codes](/developers/api-reference/api-responses).
AccountNumber
string
Account number for bank account. This value is returned masked in responses.
Legalname
string
Business legal name.
AddressAddtlNullable
string
Additional line for the address.
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Payabli publishes across the network.
