Update vendor
Updates a vendor's information. Send only the fields you need to update.
Request
- Base URL: https://api-sandbox.payabli.com/api
- URL: https://api-sandbox.payabli.com/api/Vendor/{idVendor}
- Auth: HTTP bearer
Path parameters
Vendor ID.
Request body
Custom number identifying the vendor. Must be unique in paypoint. Can't be blank.
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.
{
"additionalData": {
"key1": "value1",
"key2": "value2",
"key3": "value3"
}
}
The address.
Additional line for the address.
Vendor's city. Required if any address field is provided.
Vendor's country. Must be US or CA. Defaults to US if not provided.
Custom field 1 for vendor
Custom field 2 for vendor
Account number of paypoint in the vendor side.
EIN/Tax ID for vendor. Must be nine digits formatted as XX-XXXXXXX (for example, 12-3456789).
Email address.
Internal identifier for global vendor account.
A location code used to identify the vendor's location.
Business Merchant Category Code (MCC). This resource lists MCC codes.
Primary name for vendor. Required for new vendor.
Secondary name for vendor. If provided, allowed characters are the same as the name1 field.
Alternative name used to receive paper check.
Alternative name used to receive paper check.
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
Vendor's phone number. Phone number can't contain non-digit characters like hyphens or parentheses.
Remittance street address. Used for mailing paper checks. Required if any remittance address field is provided.
For a PO Box address, include only the PO Box in this field, for example PO Box 29652. Put the rest of the address, such as a department number, in remitAddress2.
Remittance address additional line, such as a suite or unit number. Used for mailing paper checks. Always optional.
For a PO Box address, this field holds the part of the address that follows the PO Box, for example Dept# 880662.
Remittance address city. Used for mailing paper checks. Required if any remittance address field is provided.
Remittance address country. Used for mailing paper checks. Must be US or CA. Defaults to US if not provided.
Remittance email address. Used for sending virtual cards and other information about payouts.
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.
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.
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.
Vendor's status. Allowed values:
- 0 Inactive
- 1 Active
- -99 Deleted
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).
Identifier for the vendor's default stored payment method.
Response
Success
Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.
Auxiliary validation used internally by payment pages and components.
Code for the response. Learn more in API Response Codes.
If the request was successful, this field contains the identifier for the vendor.
Response text for operation: 'Success' or 'Declined'.
Changes
No recorded changes to this operation across all 1 revision of this API.