POST
/
Organization

Authorizations

requestToken
string
header
required

Most endpoints require an organization token. Some endpoints require an application token, and those endpoints are noted.

Headers

idempotencyKey
string

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.

Body

orgName
string
required

The name of the organization.

orgType
integer
required

The organization type. Currently, this must be 0.

replyToEmail
string
required

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

billingInfo
object
contacts
object[] | null

List of contacts.

hasBilling
boolean | null
hasResidual
boolean | null
orgAddress
string | null

The organization's address.

orgCity
string | null

The organization's city.

orgCountry
string | null

The organization's country.

orgEntryName
string | null

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

orgId
string | null

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".

Contains details about a file. See See fileObject Object Model for a complete reference. Max upload size is 30 MB.

orgParentId
integer

The ID of the org's parent organization.

orgState
string | null

The organization's state.

orgTimezone
integer | null
default:
0

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

orgWebsite
string | null

The organization's website.

orgZip
string | null

The organization's ZIP code.

services
object[] | null

Response

200 - application/json
isSuccess
boolean

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

responseData

Returns the organization ID.

responseText
string | null

Response text for operation: 'Success' or 'Declined'.

Was this page helpful?