Create organization

from payabli import Contacts, FileContent, Instrument, payabli
client = payabli(
    api_key="YOUR_API_KEY",
)
client.organization.add_organization(
    idempotency_key="6B29FC40-CA47-1067-B31D-00DD010662DA",
    billing_info=Instrument(
        ach_account="123123123",
        ach_routing="123123123",
        billing_address="123 Walnut Street",
        billing_city="Johnson City",
        billing_country="US",
        billing_state="TN",
        billing_zip="37615",
    ),
    contacts=[
        Contacts(
            contact_email="herman@hermanscoatings.com",
            contact_name="Herman Martinez",
            contact_phone="3055550000",
            contact_title="Owner",
        )
    ],
    has_billing=True,
    has_residual=True,
    org_address="123 Walnut Street",
    org_city="Johnson City",
    org_country="US",
    org_entry_name="pilgrim-planner",
    org_id="123",
    org_logo=FileContent(
        f_content="TXkgdGVzdCBmaWxlHJ==...",
        filename="my-doc.pdf",
        ftype="pdf",
        furl="https://mysite.com/my-doc.pdf",
    ),
    org_name="Pilgrim Planner",
    org_parent_id=236,
    org_state="TN",
    org_timezone=-5,
    org_type=0,
    org_website="www.pilgrimageplanner.com",
    org_zip="37615",
    reply_to_email="email@example.com",
)

{
  "responseText": "Success",
  "isSuccess": true,
  "responseData": 245
}

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

Authentication

requestTokenstring

API Key authentication via header

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

orgLogoobjectOptional

Contains details about a file. Max upload size is 30 MB.

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.

responseTextstring

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

isSuccessboolean or null

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

responseDatastring or integer or null

Returns the organization ID.

Create organization

Authentication

Headers

Request

Response

Errors