Get Organization Details by OrgId

Authorizations

requestToken

string

header

required

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

Path Parameters

orgId

integer

required

The numeric identifier for organization, assigned by Payabli.

Response

200 - application/json

billingInfo

object

contacts

object[] | null

List of contacts.

createdAt

string

Timestamp of when record was created, in UTC.

hasBilling

boolean | null

hasResidual

boolean | null

idOrg

integer | null

Organization ID. Unique identifier assigned to an org by Payabli.

isRoot

boolean | null

When true, indicates that this is the organization's root template.

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

integer | null

Organization ID. Unique identifier assigned to an org by Payabli.

orgLogo

object

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

orgName

string

The name of the organization.

orgParentId

integer

The ID of the org's parent organization.

orgParentName

string | null

The name of the parent organization.

orgState

string | null

The organization's state.

orgTimezone

integer | null

default:

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

orgType

integer

The organization type. Currently, this must be 0.

orgWebsite

string | null

The organization's website.

orgZip

string | null

The organization's ZIP code.

recipientEmailNotification

boolean

default:

true

When true, Payabli will send the applicant a boarding link. Set this value to false if you are sending pre-filled applications via the API and don't want Payabli to send the applicant an email to complete the boarding application.

replyToEmail

string

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

resumable

boolean

default:

true

When true, the applicant can save an incomplete application and resume it later. When false, the applicant won't have an option to save their progress, and must complete the application in one session.

services

object[] | null

summary

object

users

object[] | null

users.Access

object[] | null

users.AdditionalData

string | null

Custom dictionary of key:value pairs. You can use this field to store any data related to the object or for your system. Example usage:

{
  "additionalData": {
    "key1": "value1",
    "key2": "value2",
    "key3": "value3"
  }
}

users.createdAt

string

The timestamp for the user's creation, in UTC.

users.Email

string | null

The user's email address.

users.language

string | null

The user's locale for PartnerHub and PayHub localization. Supported values:

en
es

users.lastAccess

string | null

The timestamp for the user's last activity, in UTC.

users.Name

string | null

users.Phone

string | null

The user's phone number.

users.Scope

object[] | null

users.snData

string | null

Additional data provided by the social network related to the customer.

users.snIdentifier

string | null

Identifier or token for customer in linked social network.

users.snProvider

string | null

Social network linked to customer. Possible values: facebook, google, twitter, microsoft.

users.timeZone

integer | null

default:

Timezone, in UTC offset. For example, -5 is Eastern time.

users.userId

integer

The user's ID in Payabli.

users.UsrMFA

boolean | null

When true, multi-factor authentication (MFA) is enabled.

users.UsrMFAMode

integer

users.UsrStatus

enum<integer> | null

The user's status:

Inactive: 0
Active: 1
Deleted: -99
Locked: 85

Available options:

0,

1,

-99,

85

API Basics

Pay In Endpoints

Pay Out Endpoints

Pay Ops Endpoints

Object Models

Get Organization Details by OrgId

Authorizations

Path Parameters

Response