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 Boarding Template by ID
Retrieves a boarding template’s details by ID.
Authorizations
Most endpoints require an organization token. Some endpoints require an application token, and those endpoints are noted.
Path Parameters
The boarding template ID. Can be found at the end of the boarding template URL in PartnerHub. Example: https://partner-sandbox.payabli.com/myorganization/boarding/edittemplate/80. Here, the template ID is 80.
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.
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 minimum number of documents the applicant must upload with the application.
When true, makes the section visible on 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.
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.
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.
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.
Controls how to present the batchCutoffTime field on the application. If this field is not sent, batch cut off time defaults to 5 ET.
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.
Controls how to present the batchCutoffTime field on the application. If this field is not sent, batch cut off time defaults to 5 ET.
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.
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.
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.
Was this page helpful?