Organization

Add organization

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

post/Organization

Request

  • Base URL: https://api-sandbox.payabli.com/api
  • URL: https://api-sandbox.payabli.com/api/Organization
  • Auth: HTTP bearer

Headers

idempotencyKeystring

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. The key persists for 2 minutes. After 2 minutes, you can reuse the key if needed.

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 body

hasBillingboolean
hasResidualboolean
orgAddressstring

The organization's address.

orgCitystring

The organization's city.

orgCountrystring

The organization's country.

orgEntryNamestring

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

orgIdstring

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

orgNamestring required

The name of the organization.

orgParentIdinteger

The ID of the org's parent organization.

orgStatestring

The organization's state.

orgTimezoneinteger

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

orgTypeinteger required

The organization type. Currently, this must be 0.

orgWebsitestring

The organization's website.

orgZipstring

The organization's ZIP code.

replyToEmailstring email 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.

Response

Success.

isSuccessboolean

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

responseTextstring required

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

Changes

No recorded changes to this operation across all 1 revision of this API.