Create organization

Creates an organization under a parent organization. This is also referred to as a suborganization.

Headers

requestTokenstringRequired
idempotencyKeystringOptional

A unique ID you can include to prevent duplicating objects or transactions if a request is sent more than once. This key is not generated in Payabli, you must generate it yourself.

Request

This endpoint expects an object.
orgNamestringRequired

The name of the organization.

orgTypeintegerRequired

The organization type. Currently, this must be 0.

replyToEmailstringRequiredformat: "email"

Email address for organization-level communications, such as messages about why an application was declined. This is required by commerce laws in the US.

serviceslist of objectsOptional
billingInfoobjectOptional
contactslist of objectsOptional

List of contacts.

hasBillingbooleanOptional
hasResidualbooleanOptional
orgAddressstringOptional

The organization’s address.

orgCitystringOptional

The organization’s city.

orgCountrystringOptional

The organization’s country.

orgEntryNamestringOptional

The entryname for the org, in string format. If you leave this blank, Payabli uses the DBA name.

orgIdstringOptional

An alternate ID for the organization, in string format. This can be your internal identifier for an org, and is typically a name, like “My Suborganization”.

orgParentIdlongOptional

The ID of the org’s parent organization.

orgStatestringOptional

The organization’s state.

orgTimezoneintegerOptional

The org’s timezone, in UTC offset. For example, -5 is Eastern time.

orgWebsitestringOptional

The organization’s website.

orgZipstringOptional

The organization’s ZIP code.

Response

Success.

isSuccessbooleanOptional

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

responseDatastring or integerOptional

Returns the organization ID.

responseTextstringOptional

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

Errors