Skip to navigation

Create an organization

Beta
View as MarkdownOpen in Claude

Creates an organization. Provide exactly one of business (to create the business inline, recommended) or businessReference (an existing business). In intelligent boarding, an organization is a kind of paypoint, so the request takes the paypoint create fields except paypointType. Payabli sets the organization type itself. An organization isn’t underwritten, so only the fields needed to create the records are required. New organizations start in pending. If you don’t set parentPaypointReference, the organization nests under the organization your credential belongs to. Returns 409 if an organization with the same externalId already exists.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
Create business inlineobjectRequired

Create an organization and its business together. Provide business plus doingBusinessAs. All other fields are optional.

OR
Use existing businessobjectRequired

Create an organization under an existing business. Provide businessReference plus doingBusinessAs. All other fields are optional.

OR
All fieldsobjectRequired

All fields accepted when creating an organization. Provide exactly one of business or businessReference.

Response

Organization 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 paypoint.

Errors

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