Update vendor

View as MarkdownOpen in Claude
Updates a vendor's information. Send only the fields you need to update.

Authentication

requestTokenstring
API Key authentication via header

Path parameters

idVendorintegerRequired
Vendor ID.

Request

This endpoint expects an object.
vendorNumberstringOptional
Custom number identifying the vendor. Must be unique in paypoint. Can't be blank.
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. Max length for a value is 100 characters. Example usage:

1{
2 "additionalData": {
3 "key1": "value1",
4 "key2": "value2",
5 "key3": "value3"
6 }
7}
address1stringOptional

Vendor’s street address. If any address field is provided, this field is required along with city, state, and zip. Allowed characters are letters, numbers, spaces, and `. ,

address2stringOptional
Additional line for vendor's address, such as a suite or unit number. Always optional.
billingDataobjectOptional
Object containing vendor's bank information.
citystringOptional
Vendor's city. Required if any address field is provided.
contactslist of objectsOptional
Array of objects describing the vendor's contacts.
countrystringOptional

Vendor’s country. Must be US or CA. Defaults to US if not provided.

customField1stringOptional
Custom field 1 for vendor
customField2stringOptional
Custom field 2 for vendor
customerVendorAccountstringOptional
Account number of paypoint in the vendor side.
einstringOptional

EIN/Tax ID for vendor. Must be nine digits formatted as XX-XXXXXXX (for example, 12-3456789).

emailstringOptionalformat: "email"<=320 characters
Vendor's email address. Required for vCard.
internalReferenceIdlongOptional
Internal identifier for global vendor account.
locationCodestringOptional
A location code used to identify the vendor's location.
mccstringOptional

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

name1stringOptional

Primary name for vendor. Required for new vendor. Allowed characters are letters, numbers, spaces, and the following symbols `. , ’ & ( )

name2stringOptional

Secondary name for vendor. If provided, allowed characters are the same as the name1 field. Letters, numbers, spaces, and `. , ’ & ( )

payeeName1stringOptional
Alternative name used to receive paper check.
payeeName2stringOptional
Alternative name used to receive paper check.
paymentMethodstringOptional

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
phonestringOptionalformat: "^[0-9]+$"

Vendor’s phone number. Phone number can’t contain non-digit characters like hyphens or parentheses.

remitAddress1stringOptional

Remittance street address. Used for mailing paper checks. Required if any remittance address field is provided. Allowed characters are letters, numbers, spaces, and `. ,

remitAddress2stringOptional
Remittance address additional line, such as a suite or unit number. Used for mailing paper checks. Always optional.
remitCitystringOptional
Remittance address city. Used for mailing paper checks. Required if any remittance address field is provided.
remitCountrystringOptional

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

remitEmailstringOptionalformat: "email"
Remittance email address. Used for sending virtual cards and other information about payouts.
remitStatestringOptional
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.
remitZipstringOptional

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.

statestringOptional

Vendor’s state or province. Required if any address field is provided. Must be a valid US state abbreviation (such as CA, NY) or Canadian province abbreviation (such as ON, BC), depending on the country value.

vendorStatusintegerOptional

Vendor’s status. Allowed values:

  • 0 Inactive

  • 1 Active

  • -99 Deleted

zipstringOptional

Vendor’s ZIP or postal code. Required if any address field is provided. For US addresses, use five digits (12345) or ZIP+4 format (12345-6789).

defaultMethodIdstringOptional
Identifier for the vendor's default stored payment method.
attachmentobjectOptional

PDF invoice attachment for AI-powered vendor enrichment. When this feature is enabled and you include an attachment, the invoice is scanned and extracted vendor information is merged into the request. Fields in the request body take precedence over extracted data. If the scan fails, vendor creation proceeds with the original request data.

See the vendor enrichment guide for details. Contact Payabli to enable this feature.

Response

Success
responseTextstring

Response text for operation: ‘Success’ or ‘Declined’.

isSuccessboolean

Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.

pageIdentifierstring
Auxiliary validation used internally by payment pages and components.
responseCodeinteger

Code for the response. Learn more in API Response Codes.

responseDatainteger
If the request was successful, this field contains the identifier for the vendor.

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error
503
Service Unavailable Error