Payabli Boarding API
The Boarding API from Payabli — 12 operation(s) for boarding.
Payabli Boarding API is one of 33 APIs that Payabli publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Boarding. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 13 operations across 12 paths, and defines 177 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.
13 operations
12 paths
177 schemas
1 DELETE7 GET3 POST2 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Payabli Boarding 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 13
Across 12 paths, the API surfaces 13 operations — 1 DELETE, 7 GET, 3 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
Boarding 13
POST
/Boarding/app
Create boarding application
POST
/Boarding/applications
Create multi-product boarding application
GET
/Boarding/read/{appId}
Get boarding application by ID
GET
/Boarding/applications/{paypointId}
Get multi-product boarding applications for a paypoint
GET
/Query/boarding/{orgId}
Get list of applications for an organization
PUT
/Boarding/app/{appId}
Update boarding application
DELETE
/Boarding/app/{appId}
Delete boarding application
POST
/Boarding/read/{xId}
Get boarding application by auth
GET
/Boarding/linkbyId/{boardingLinkId}
Get boarding link by ID
GET
/Boarding/linkbyTemplate/{templateId}
Get boarding link by template ID
PUT
/Boarding/applink/{appId}/{mail2}
Get link or email a link for a boarding application
GET
/Boarding/link/{boardingLinkReference}
Get boarding Link by reference
GET
/Query/boardinglinks/{orgId}
Get list of boarding links for organization
Schemas 177
The contract defines 177 schemas that model the data the API accepts and returns. The most detailed are ApplicationQueryRecord (63 properties), ApplicationDetailsRecord (61 properties), ApplicationDataPayIn (57 properties), ApplicationData (56 properties). Each schema is shown below with its type and property counts.
Ticketamt
number
The average transaction size that the business expects to process. For example, if you process $10,000 a month across 10 transactions, that's an average ticket…
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…
ApplicationDataPayIn
object
Fields for Pay In boarding applications.
57 properties
9 required
ContactsField
array
List of contacts.
QuerySummary
object
6 properties
CardLinkTypes
object
4 properties
AccountId
string
Custom identifier for payment connector.
FaxNumber
string
Fax number.
OdpSetupProcessingRegion
string
Region where payment processing occurs.
Bstate
string
Business state.
BankName
string
Name of bank for account.
Bnk
object
4 properties
Licensestate
string
Business license issuing state or province.
PayabliErrorBodyResponseData
object
Object with detailed error context.
2 properties
SignerSsn
string
The signer's SSN.
ReferenceTemplateId
integer
Email
string
Email address.
AcceptOauth
boolean
AddApplicationRequest
BoardingAvgMonthlyBill
string
This is the total number of bills the business pays each month. For example, if your business pays an electric bill of $500, an internet bill of $150, and vari…
Bphone
string
Business phone number.
BoardingBusinessFax
string
The business's fax number.
SignerPhone
string
The signer's phone number.
RoomIdNotInUse
integer
Field not in use on this endpoint. It always returns 0.
PayoutHighTicketAmount
number
The largest amount for a bill you will pay through our service. For example, if your business paid for 3 bills each month for $500, $1000, and $5000 respective…
PageIdentifier
string
Auxiliary validation used internally by payment pages and components.
AppId
integer
Boarding application ID.
Pagesize
integer
Number of records on each response page.
Bcountry
string
Business country in ISO-3166-1 alpha 2 format. See [ISO 3166-1](https://en.wikipedia.org/wiki/ISO3166-1) for more information.
AcceptRegister
boolean
Busstartdate
string
Business start date. Accepted formats: - YYYY-MM-DD - MM/DD/YYYY
FileContent
object
Contains details about a file. Max upload size is 30 MB.
4 properties
CardSection
object
3 properties
PayoutAverageTicketLimit
number
The average amount of each bill you pay through our service. For example, if your business paid 3 bills for a total of $1,500 then your average bill size is $5…
CreatedAt
string
Timestamp of when record was created, in UTC.
SignerState
string
The signer's state.
ResponseText
string
Response text for operation: 'Success' or 'Declined'.
PayabliApiResponse00Responsedatanonobject
object
6 properties
1 required
BankAccountFunction
integer
Indicates the function of the bank account: - 0 — Deposits - 1 — Withdrawals - 2 — Deposits & Withdrawals - 3 — Remittances - 4 — Remittances & Deposits - 5 —…
ApplicationData
object
56 properties
Baddress2
string
Business address additional line. If used, this must be the physical address of the business, not a P.O. box.
ApplicationDataOdpContactsItem
object
5 properties
Mcountry
string
Business mailing country.
ApplicationDataPayInServicesAch
object
Configuration for which ACH SEC codes the user is allowed to use.
3 properties
DSection
object
2 properties
Whencharged
string
Describes when customers are charged for goods or services.
SignerDataRequest
object
Information about the application's signer.
17 properties
SignerAddress1
string
Additional line for the signer's address. If used, this must be the physical address of the signer, not a P.O. box.
SignerAcceptance
boolean
The signer's acceptance status. A true or false indicating an acceptance to the terms of service with the root org or provider.
OdpSetup
object
6 properties
PayabliErrorBody
object
Shape returned by every Payabli API error response. The responseData object carries human-readable error context.
4 properties
2 required
QueryBoardingLinksResponse
object
2 properties
CreateApplicationFromPaypointRequest
object
Request to create a boarding application linked to an existing paypoint. Used for adding new services to a paypoint without creating a duplicate record.
5 properties
3 required
OnCreate
string
Action to take when the application is created. The only currently supported option is submitApplication. Use this when you have collected eSignature elsewhere…
SSection
object
2 properties
SignerZip
string
The signer's ZIP code.
Annualrevenue
number
Annual revenue amount.
PayoutCreditLimit
number
The maximum amount of credit that our lending partner has authorized to the business for on-demand payouts. It's the upper boundary on how much you can spend o…
BankAccountHolderType
string
Describes whether the bank is a personal or business account.
Mzip
string
Business mailing ZIP.
CList
object
4 properties
PSection
object
12 properties
ApplicationDataManaged
object
41 properties
1 required
AdditionalDataString
string
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: json { "additionalData"…
RoutingAccount
string
Routing number of bank account.
QueryBoardingLinksResponseRecordsItem
object
10 properties
Totalrecords
integer
Total number of records in response.
Bank
object
Object that contains bank account details.
15 properties
GeneralEvents
object
5 properties
Ein
string
Business EIN or tax ID. This value is masked in API responses.
RequestAppByAuth
object
2 properties
IsSuccess
boolean
Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.
Dbaname
string
The alternate or common name that this business is doing business under, usually referred to as a DBA name.
RepCode
string
Sales representative code. This is an optional field that can be used to track the sales representative associated with the application.
BankNickname
string
User-defined name for the bank account.
Responsedata
object
The object containing the response data.
EntryAttributes
string
ApplicationDataPayInServices
object
3 properties
2 required
ApplicationDataPayInOwnershipItem
object
16 properties
TemplateName
string
The template name.
Website
string
The business website address. Include only the domain and TLD, do not enter the protocol (http/https). For example: www.example.com is acceptable.
ApplicationDetailsRecordMessagesItem
object
11 properties
OwnType
string
The business ownership type.
SignerCountry
string
The signer's country in ISO-3166-1 alpha 2 format. See [ISO 3166-1](https://en.wikipedia.org/wiki/ISO3166-1) for more.
CardSetup
object
4 properties
ApplicationDataOdpOwnershipItem
object
16 properties
Avgmonthly
number
Average total amount of transactions in your local currency that are processed each month.
BAddress
object
12 properties
SignerName
string
The signer's name.
BankAccountHolderName
string
The accountholder's name.
LinkRow
object
1 property
OSection
object
2 properties
TemplateCode
string
The internal code for the template.
AchLinkTypes
object
3 properties
Services
object
Controls which services will be enabled for the merchant.
3 properties
BoardingLinkQueryRecord
object
12 properties
AdditionalDataMap
object
Custom dictionary of key:value pairs. You can use this field to store any data related to the object or for your system. If you are using [custom identifiers](…
ApplicationDataManagedOwnershipItem
object
16 properties
ASection
object
3 properties
PayabliApiResponse00
object
5 properties
1 required
RepOffice
string
Sales representative office location. This is an optional field that can be used to track the sales representative office associated with the application.
SignerData
object
Information about the application's signer.
18 properties
Bcity
string
Business city.
CreateApplicationFromPaypointResponse
object
Response returned when creating a boarding application linked to an existing paypoint.
6 properties
1 required
AttestationDate
string
Date the attestation was provided for PCI Compliance (pciAttestation), in MM/DD/YYYY format.
Ownership
array
List of Owners with at least a 25% ownership.
LinkData
object
4 properties
Highticketamt
number
Highest ticket amount.
SignDate
string
Date when the signer signed the document. Accepted formats: YYYY-MM-DD, MM/DD/YYYY.
Whenprovided
string
Describes when goods or services are provided, from time of transaction.
FileContentFtype
string
The MIME type of the file (if content is provided).
RequiredElement
boolean
When true, the element is required.
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…
License
string
Business license ID or state ID number.
Mcc
string
Business Merchant Category Code (MCC). [This resource](https://github.com/greggles/mcc-codes/blob/main/mcccodes.csv) lists MCC codes.
Mstate
string
The business's mailing address state.
Responsedatanonobject
The response data.
TemplateId
integer
The associated boarding template's ID in Payabli.
SalesCode
string
LastModified
string
Timestamp of when record was last updated, in UTC.
Signeraddress
string
The signer's address. This must be the physical address of the signer, not a P.O. box.
QueryBoardingAppsListResponse
object
2 properties
BoardingAverageBillSize
string
This is the average amount of each bill you pay through our service. For example, if your business paid 3 bills for a total of $1,500 then your average bill si…
ExternalPaypointId
string
A custom identifier for the paypoint, if applicable.
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…
Binweb
integer
Numeric percent of volume processed on web. To pass validation, binperson, binweb, and binphone must total 100 together.
BSection
object
2 properties
Binperson
integer
Numeric percent of volume processed in person. To pass validation, binperson, binweb, and binphone must total 100 together.
CreateApplicationFromPaypointResponseData
object
2 properties
PayoutAverageMonthlyVolume
number
The total number of bills the business pays each month. For example, if your business pays an electric bill of $500, an internet bill of $150, and various supp…
BankData
array
Information about associated bank accounts.
Maddress1
string
Additional line for the business's mailing address.
Orgid
integer
Organization ID. Unique identifier assigned to an org by Payabli.
Attachments
array
Array of fileContent objects with attached documents. Max upload size is 30 MB.
SignerDob
string
The signer's date of birth.
RepName
string
Sales representative name. This is an optional field that can be used to track the sales representative associated with the application.
Contacts
object
5 properties
OrgParentName
string
The name of the parent organization.
Maddress
string
The business's mailing address.
BoardingApplicationAttachments
object
2 properties
Binphone
integer
Numeric percent of volume processed by phone. To pass validation, binperson, binweb, and binphone must total 100 together.
ExportFormat
string
Export format for file downloads. When specified, returns data as a file instead of JSON.
ReferenceName
string
Whendelivered
string
When goods and services are delivered.
ApplicationQueryRecord
object
63 properties
ApplicationDataPayInServicesCard
object
4 properties
BDetails
object
11 properties
ApplicationDataManagedContactsItem
object
5 properties
SignedDocumentReference
string
Reference to the signed document.
ApplicationDataOdp
object
47 properties
5 required
Whenrefunded
string
Describes the business refund policy.
Baddress1
string
Business address. This must be a physical address, not a P.O. box.
BuilderData
object
6 properties
PhoneNumber
string
Phone number.
Bsummary
string
A summary of what the business sells in terms of goods or services.
Source
string
Custom identifier to indicate the transaction or request source.
Mcity
string
The business's mail city.
Taxfillname
string
Business name in tax document. This is only relevant if a government entity has given you an alternative name to file tax documents with.
Bzip
string
Business ZIP.
BoardingStatus
integer
The application's status in the merchant boarding process. See [Boarding Status Reference](/developers/references/boarding-statuses) for more.
ValueTemplates
string
PciAttestation
boolean
When true, indicates that the merchant acknowledges PCI responsibilities and can be enrolled in the PCI program for breach insurance.
PairFiles
object
3 properties
BoardingBusinessPhone
string
The business's phone number.
TypeAccount
string
Type of bank account: Checking or Savings.
OList
object
15 properties
Owners
object
16 properties
SignerCity
string
The signer's city.
Responsecode
integer
Code for the response. Learn more in [API Response Codes](/developers/api-reference/api-responses).
BasicTable
object
2 properties
ApplicationDetailsRecord
object
61 properties
ApplicationDataPayInContactsItem
object
5 properties
AccountNumber
string
Account number for bank account. This value is returned masked in responses.
Legalname
string
Business legal name.
AchSection
object
3 properties
ReadOnly
boolean
When true, the element is read-only.
AchSetup
object
Configuration for which ACH SEC codes the user is allowed to use.
3 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Payabli 12
Other APIs Payabli publishes across the network.
Payabli Bill API
Payabli chargeBacks API
Payabli checkCapture API
Payabli Cloud API
Payabli Customer API
Payabli Export API
Payabli Funding API
Payabli ghostCard API
Payabli hostedPaymentPages API
Payabli Import API
Payabli Invoice API
Payabli lineItem API
#Boarding
Where this information came from
This is an independent, third-party profile of Payabli Boarding 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.