Skip to navigation

Create a business

Beta
View as MarkdownOpen in Claude

Creates a business, the legal entity behind a paypoint. New businesses start in Draft. Set parentReference to the organization the business belongs to, or omit it to use the organization your credential belongs to.

Authentication

AuthorizationBearer

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

Request

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

A free-text description of the business.

legalStructureenumOptional

The business’s legal structure. Case-insensitive, and several inputs normalize to the same canonical value on read (for example, llc and limited-liability-company both read back as LimitedLiabilityCompany).

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
The business's addresses.
paymentMethodslist of objectsOptional
The bank accounts and cards attached to the business.
customDatamap from strings to anyOptional

Arbitrary key-value data you attach to the business. Payabli stores the applicant’s answers to a boarding template’s custom questions under the templateAnswers key.

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.
taxReferencestringOptional
The business tax identifier, for example an EIN.
parentReferencestringOptional
The organization entrypoint the business belongs to. Omit to use the organization your credential belongs to.

Response

Business created.
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 created business.
warningslist of objects or null

Non-blocking warnings.

Errors

400
Bad Request Error
401
Unauthorized Error
409
Conflict Error
500
Internal Server Error