Skip to navigation
APIPay Ops endpointsBusinesses

Update a business

Beta
View as MarkdownOpen in Claude
Applies a partial update to a business. Send only the fields you want to change.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

businessReferencestringRequired

The business reference (businessUuid).

Request

This endpoint expects an object.
externalIdstringOptional
Your own identifier for the business.
legalNamestringOptional
The registered legal name of the business.
descriptionstringOptional

A free-text description of the business.

legalStructureenumOptional
The business's legal structure. Accepts the same values as create, and normalizes to a canonical value on read.
stockSymbolstringOptional
The stock ticker symbol, if the business is publicly traded.
incorporationStatestringOptional
The state where the business is incorporated.
taxIdCountrystringOptional
The country that issued the business's tax identifier.
establishedDatedatetimeOptional
The date the business was established.
numberOfEmployeesintegerOptional
The number of employees.
annualRevenuedoubleOptional
The business's annual revenue.
websitestringOptional
The business's website URL.
merchantCatCodestringOptional

The merchant category code (MCC) that classifies the business.

timezonestringOptional
The business's time zone.
phonelist of stringsOptional
Phone numbers for the business.
emailslist of stringsOptional
Email addresses for the business.
operatingSeasonslist of enumsOptional

The seasons the business operates in. Values are case-insensitive on input and returned capitalized.

Allowed values:
addressDetailslist of objectsOptional

A non-empty addressDetails is rejected on update. Manage a business’s addresses through the /v2/businesses/{businessReference}/addresses endpoints instead. An omitted field or an empty array is accepted as “no address change requested.”

paymentMethodslist of objectsOptional
The bank accounts and cards attached to the business.
customDatamap from strings to anyOptional

Key-value data to merge into the business’s stored customData. Payabli stores the applicant’s answers to a boarding template’s custom questions under the templateAnswers key.

When you update a business, Payabli merges customData into the stored value, following JSON Merge Patch (RFC 7396). Keys you don’t send are kept at every depth, and nested objects merge key by key. Strings, numbers, Boolean values, and arrays replace the stored value, and arrays aren’t merged. Send a key as null to delete it, such as {"crmId": null}. A customData that isn’t an object, such as an array, replaces the stored value whole. Leave out customData to keep it as is.

The customData you send can be up to 65,536 bytes serialized. The limit applies to the request, not to the merged result.

isForeignOwnedbooleanOptional

Whether the business is foreign-owned.

isTaxExemptbooleanOptional

Whether the business is tax-exempt.

taxExemptClassificationstringOptional

The business’s tax-exempt classification, such as 501(c)(3).

processingMetricsobjectOptional
Expected Pay In processing profile for the business.
payoutMetricsobjectOptional
Expected Pay Out profile for the business.
licensestringOptional
The business's license number.
licenseStatestringOptional
The state that issued the business's license.

Response

Business updated.
successboolean
Whether the request succeeded.
messagestring or null

A human-readable result message.

traceIdstring or null
The trace identifier for the request, useful for support.
dataobject or null
The updated business.
warningslist of objects or null

Non-blocking warnings.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
500
Internal Server Error