Payabli Templates API is one of 33 APIs that Payabli publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Templates. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes
4 operations
across 4 paths,
and defines 75 schemas.
It is described by OpenAPI 3.1.0, at version 1.0.0.
Requests are made against 2 base URLs: https://api-sandbox.payabli.com/api, https://api.payabli.com/api.
4 operations4 paths75 schemas1 DELETE3 GET
Metadata
The identity and technical contract details declared by the specification.
Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.payabli.com/api
Authentication
HTTP Bearer, API Key
Resource Areas
1
Authentication & Security 2
Payabli Templates API declares
2 security schemes
for authenticating requests.
It accepts HTTP bearer tokens (BearerAuth).
An API key is passed in the header as requestToken (APIKeyAuth).
BearerAuth — OAuth2 Bearer access token from the client-credentials flow. See [OAuth authentication](/developers/oauth-authentication).
APIKeyAuth — Long-lived API token sent in the requestToken header. See [API token authentication](/developers/api-tokens).
Paths & Operations 4
Across 4 paths, the API surfaces 4 operations — 1 DELETE, 3 GET. Each is listed below with its method, path, parameters, and response codes.
Templates 4
GET
/Templates/getlink/{templateId}/{ignoreEmpty}
Generate boarding link from template
getlinkTemplate3 params→ 200400401500503
GET
/Templates/get/{templateId}
Get boarding template by ID
getTemplate2 params→ 200400401500503
GET
/Query/templates/{orgId}
Get list of boarding templates for organization
ListTemplates6 params→ 200400401500503
DELETE
/Templates/{templateId}
Delete boarding template
DeleteTemplate2 params→ 200400401500503
Schemas 75
The contract defines 75 schemas that model the data the API accepts and returns. The most detailed are CardService (31 properties), BusinessSection (25 properties), OwnersSection (25 properties), ProcessingSection (20 properties). Each schema is shown below with its type and property counts.
TierItem
object
4 properties
CardFlatSection
object
2 properties
AchTypesTiers
object
3 properties
BoardingLinkId
integer
The boarding link ID. This is found at the end of the boarding link reference name. For example: https://boarding.payabli.com/boarding/app/myorgaccountname-000…
CardAcceptanceElement
object
6 properties
AchTypesPass
object
3 properties
IsRoot
boolean
When true, indicates that this is the organization's root template.
PosCol
integer
The element's column position.
TemplateCode
string
The internal code for the template.
QuerySummary
object
6 properties
SalesSection
object
2 properties
OrgParentName
string
The name of the parent organization.
UnderwritingDataResponse
object
Underwriting data is used to manage risk orchestration in the boarding application lifecycle.
2 properties
ReferenceName
string
BusinessSection
object
Details about a business.
25 properties
CardTypePass
object
4 properties
AchPassThroughSection
object
3 properties
PayabliApiResponseTemplateId
object
5 properties1 required
TemplateElement
object
6 properties
DocumentSectionTermsAndConditions
object
2 properties
ServicesSection
object
Details about pricing and payment services for a business.
5 properties
ResponseText
string
Response text for operation: 'Success' or 'Declined'.
TemplateQueryRecord
object
13 properties
CardIcpSection
object
2 properties
CardTypes
object
4 properties
PayabliErrorBody
object
Shape returned by every Payabli API error response. The responseData object carries human-readable error context.
4 properties2 required
PayabliErrorBodyResponseData
object
Object with detailed error context.
2 properties
CardFeeSection
object
12 properties
ReferenceTemplateId
integer
DocumentSection
object
11 properties
SubFooter
string
PolicyId
string
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…
Visible
boolean
When true, makes the section visible on the application.
BoardingLinkApiResponse
object
2 properties1 required
PosRow
integer
The element's row position.
AcceptOauth
boolean
RequiredElement
boolean
When true, the element is required.
OwnersSection
object
Information about a business owner.
25 properties
CardType
object
4 properties
ProcessingSection
object
20 properties
AchTypes
object
3 properties
TemplateContentResponse
object
7 properties
AchFeeSection
object
13 properties
UnderWritingMethod
string
This field controls which method is used to handle risk orchestration. - automatic: Sends the application through the automatic underwriting workflow using the…
TemplateQueryResponse
object
2 properties
RecipientEmailNotification
boolean
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 Payab…
Totalrecords
integer
Total number of records in response.
Responsedatanonobject
The response data.
CardPassThroughSection
object
3 properties
ValueTemplates
string
SalesCode
string
SubHeader
string
LastModified
string
Timestamp of when record was last updated, in UTC.
PageIdentifier
string
Auxiliary validation used internally by payment pages and components.
IsSuccess
boolean
Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.
BasicTemplateElement
object
3 properties
AchAbsorbSection
object
3 properties
BankSection
object
Details about a bank account.
5 properties
SignerSection
object
15 properties
Pagesize
integer
Number of records on each response page.
AchAcceptanceElement
object
6 properties
Responsecode
integer
Code for the response. Learn more in [API Response Codes](/developers/api-reference/api-responses).
AcceptRegister
boolean
Resumable
boolean
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 mus…
TierItemPass
object
6 properties
TemplateAdditionalDataField
object
8 properties
BoardingQueryLinks
object
10 properties
EntryAttributes
string
AchService
object
19 properties
CreatedAt
string
Timestamp of when record was created, in UTC.
CardService
object
31 properties
TemplateName
string
The template name.
ReadOnly
boolean
When true, the element is read-only.
TemplateAdditionalDataSection
object
2 properties1 required
DocumentSectionTermsAndConditionsTcLinksItem
object
2 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.
Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.
MCP tools for apis
4 tools reach this content
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
A second provider on the same verified email joins the account you already have.
Your account
ⓘWhere this information came from
This is an independent, third-party profile of Payabli Templates API, published by
API Evangelist. We do not operate, host, resell, or
support these APIs, and we are not affiliated with or endorsed by the company unless stated above.
Everything here is built from publicly available information — the company's own site,
developer portal, documentation, public repositories, and the specifications it publishes for public use.
Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's
public API artifacts, scored against a published rubric. They are not certifications,
endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and
you do not need to justify the request. A removed company is recorded as unrated, never scored
zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy → On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.
