Create organization
Creates an organization under a parent organization. This is also referred to as a suborganization.
Headers
requestToken
idempotencyKey
Optional but recommended A unique ID that you can include to prevent duplicating objects or transactions in the case that a request is sent more than once. This key isn’t generated in Payabli, you must generate it yourself. This key persists for 2 minutes. After 2 minutes, you can reuse the key if needed.
Request
This endpoint expects an object.
orgName
The name of the organization.
orgType
The organization type. Currently, this must be 0
.
replyToEmail
Email address for organization-level communications, such as messages about why an application was declined. This is required by commerce laws in the US.
services
billingInfo
contacts
List of contacts.
hasBilling
hasResidual
orgAddress
The organization's address.
orgCity
The organization's city.
orgCountry
The organization's country.
orgEntryName
The entryname for the org, in string format. If you leave this blank, Payabli uses the DBA name.
orgId
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".
orgLogo
Contains details about a file. Max upload size is 30 MB.
orgParentId
The ID of the org's parent organization.
orgState
The organization's state.
orgTimezone
The org’s timezone, in UTC offset. For example, -5 is Eastern time.
orgWebsite
The organization's website.
orgZip
The organization's ZIP code.
Response
Success.
responseText
Response text for operation: ‘Success’ or ‘Declined’.
isSuccess
Boolean indicating whether the operation was successful. A true
value indicates success. A false
value indicates failure.
responseData
Returns the organization ID.