API Basics
Pay In Endpoints
- MoneyIn
- Subscription
- TokenStorage
- Invoice
- LineItem
- PaymentLink
- PaymentMethodDomain
- HostedPaymentPages
- Cloud
- Wallet: Apple Pay
Pay Out Endpoints
- MoneyOut
- Bill
Pay Ops Endpoints
- Templates
- Boarding
- Chargebacks and ACH Returns
- Entities
- Notification
- Query
- Statistic
- Export
- Import
Object Models
- Object Model References
Get List of Boarding Templates for Org
Retrieves a list of boarding templates for an organization. Use filters to limit results. You can’t make a request that includes filters from the API console in the documentation. The response will not be filtered. Instead, copy the request, remove parameters= and run the request in a different client.
Authorizations
Most endpoints require an organization token. Some endpoints require an application token, and those endpoints are noted.
Path Parameters
The numeric identifier for organization, assigned by Payabli.
Query Parameters
Collection of field names, conditions, and values used to filter the query.
You must remove parameters= from the request before you send it, otherwise Payabli will ignore the filters. For example, --url '<https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20' should become --url '<https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount(gt)=1000&limitRecord=20'
See See Filters and Conditions Reference for help.
List of field names accepted:
- createdAt (gt, ge, lt, le, eq, ne)
- title (ct, nct)
- description (ct, nct)
- code (ct, nct)
- orgParentname (ct, nct)
List of comparison accepted - enclosed between parentheses:
- eq or empty => equal
- gt => greater than
- ge => greater or equal
- lt => less than
- le => less or equal
- ne => not equal
- ct => contains
- nct => not contains
- in => inside array
- nin => not inside array
List of parameters accepted:
- limitRecord : max number of records for query (default="20", "0" or negative value for all)
- fromRecord : initial record in query
Example: title(ct)=hoa return all records with title containing "hoa"
Max number of records to return for the query. Use 0 or negative value to return all records.
The number of records to skip before starting to collect the result set.
The field name to use for sorting results. Use desc(field_name) to sort descending by field_name, and use asc(field_name) to sort ascending by field_name.
Response
The boarding link ID. Can be found at the end of the boarding link reference name. The boarding link reference name. For example https://boarding.payabli.com/boarding/app/myorgaccountname-00091. The ID is 91.
Timestamp of when record was last updated, in UTC.
The name of the parent organization.
The internal code for the template.
The template name.
Timestamp of when record was created, in UTC.
When true, indicates that this is the organization's root template.
The name of the parent organization.
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.
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.
The internal code for the template.
Details about a business.
The element's column position.
The element's row position.
When true, the element is read-only.
When true, makes the section visible on the application.
The element's column position.
The element's row position.
When true, the element is read-only.
When true, makes the section visible on the application.
The element's column position.
The element's row position.
When true, the element is read-only.
When true, makes the section visible on the application.
The element's column position.
The element's row position.
When true, the element is read-only.
When true, makes the section visible on the application.
The element's column position.
The element's row position.
When true, the element is read-only.
When true, makes the section visible on the application.
The element's column position.
The element's row position.
When true, the element is read-only.
When true, makes the section visible on the application.
The element's column position.
The element's row position.
When true, the element is read-only.
When true, makes the section visible on the application.
The element's column position.
The element's row position.
When true, the element is read-only.
When true, makes the section visible on the application.
The element's column position.
The element's row position.
When true, the element is read-only.
When true, makes the section visible on the application.
The element's column position.
The element's row position.
When true, the element is read-only.
When true, makes the section visible on the application.
The element's column position.
The element's row position.
When true, the element is read-only.
When true, makes the section visible on the application.
The element's column position.
The element's row position.
When true, the element is read-only.
When true, makes the section visible on the application.
The element's column position.
The element's row position.
When true, the element is read-only.
When true, makes the section visible on the application.
The element's column position.
The element's row position.
When true, the element is read-only.
When true, makes the section visible on the application.
The element's column position.
The element's row position.
When true, the element is read-only.
When true, makes the section visible on the application.
The element's column position.
The element's row position.
When true, the element is read-only.
When true, makes the section visible on the application.
The element's column position.
The element's row position.
When true, the element is read-only.
When true, makes the section visible on the application.
The element's column position.
The element's row position.
When true, the element is read-only.
When true, makes the section visible on the application.
The element's column position.
The element's row position.
When true, the element is read-only.
When true, makes the section visible on the application.
The element's column position.
The element's row position.
When true, the element is read-only.
When true, makes the section visible on the application.
The element's column position.
The element's row position.
When true, the element is read-only.
When true, makes the section visible on the application.
The element's column position.
The element's row position.
When true, the element is read-only.
When true, makes the section visible on the application.
When true, makes the section visible on the application.
The element's column position.
The element's row position.
When true, the element is read-only.
When true, makes the section visible on the application.
Details about a bank account.
When true, makes the section visible on the application.
The minimum number of documents the applicant must upload with the application.
When true, allows the applicant to upload documents to the application.
When true, makes the section visible on the application.
Details about a bank account.
When true, makes the section visible on the application.
Information about a business owner.
The element's column position.
The element's row position.
When true, the element is read-only.
When true, makes the section visible on the application.
The element's column position.
The element's row position.
When true, the element is read-only.
When true, makes the section visible on the application.
The element's column position.
The element's row position.
When true, the element is read-only.
When true, makes the section visible on the application.
The element's column position.
The element's row position.
When true, the element is read-only.
When true, makes the section visible on the application.
Offer add more contacts
offer add more owners
The element's column position.
The element's row position.
When true, the element is read-only.
When true, makes the section visible on the application.
The element's column position.
The element's row position.
When true, the element is read-only.
When true, makes the section visible on the application.
The element's column position.
The element's row position.
When true, the element is read-only.
When true, makes the section visible on the application.
The element's column position.
The element's row position.
When true, the element is read-only.
When true, makes the section visible on the application.
The element's column position.
The element's row position.
When true, the element is read-only.
When true, makes the section visible on the application.
The element's column position.
The element's row position.
When true, the element is read-only.
When true, makes the section visible on the application.
The element's column position.
The element's row position.
When true, the element is read-only.
When true, makes the section visible on the application.
The element's column position.
The element's row position.
When true, the element is read-only.
When true, makes the section visible on the application.
The element's column position.
The element's row position.
When true, the element is read-only.
When true, makes the section visible on the application.
The element's column position.
The element's row position.
When true, the element is read-only.
When true, makes the section visible on the application.
The element's column position.
The element's row position.
When true, the element is read-only.
When true, makes the section visible on the application.
The element's column position.
The element's row position.
When true, the element is read-only.
When true, makes the section visible on the application.
The element's column position.
The element's row position.
When true, the element is read-only.
When true, makes the section visible on the application.
The element's column position.
The element's row position.
When true, the element is read-only.
When true, makes the section visible on the application.
The element's column position.
The element's row position.
When true, the element is read-only.
When true, makes the section visible on the application.
When true, makes the section visible on the application.
The element's column position.
The element's row position.
When true, the element is read-only.
When true, makes the section visible on the application.
The element's column position.
The element's row position.
When true, the element is read-only.
When true, makes the section visible on the application.
The element's column position.
The element's row position.
When true, the element is read-only.
When true, makes the section visible on the application.
The element's column position.
The element's row position.
When true, the element is read-only.
When true, makes the section visible on the application.
The element's column position.
The element's row position.
When true, the element is read-only.
When true, makes the section visible on the application.
The element's column position.
The element's row position.
When true, the element is read-only.
When true, makes the section visible on the application.
The element's column position.
The element's row position.
When true, the element is read-only.
When true, makes the section visible on the application.
The element's column position.
The element's row position.
When true, the element is read-only.
When true, makes the section visible on the application.
When true, makes the section visible on the application.
The element's column position.
The element's row position.
When true, the element is read-only.
When true, makes the section visible on the application.
The element's column position.
The element's row position.
When true, the element is read-only.
When true, makes the section visible on the application.
The element's column position.
The element's row position.
When true, the element is read-only.
When true, makes the section visible on the application.
The element's column position.
The element's row position.
When true, the element is read-only.
When true, makes the section visible on the application.
Details about pricing and payment services for a business.
Controls how to present the batchCutoffTime field on the application. If this field is not sent, batch cut off time defaults to 5 ET.
When true, makes the section visible on the application.
Controls how to present the batchCutoffTime field on the application. If this field is not sent, batch cut off time defaults to 5 ET.
When true, makes the section visible on the application.
When true, makes the section visible on the application.
Underwriting data is used to manage risk orchestration in the boarding application lifecycle.
This field controls which method is used to handle risk orchestration.
automatic: Sends the application through the automatic underwriting workflow using the providedpolicyId.manual: Puts the application into the pending review status. An analyst must manually change it's final status to approved or declined.bypass: The application won't go through Payabli's review, and proceeds directly to boarding products and services.
automatic, manual, bypass Used to identify the risk workflow used to review this account. Policy IDs must be created before using automatic underwriting, and is required when method is automatic.
Auxiliary validation used internally by payment pages and components.
Number of records on each response page.
Total amount for the records.
Total net amount for the records.
Total number of records in response.
Total number of records in response.
Was this page helpful?