Get Boarding Application by Auth
Gets a boarding application by authentication information. This endpoint requires an application API token.
Authorizations
Most endpoints require an organization token. Some endpoints require an application token, and those endpoints are noted.
Path Parameters
The application ID in Hex format. Find this at the end of the boarding link URL returned in a call to api/Boarding/applink/{appId}/{mail2}. For example in: https://boarding-sandbox.payabli.com/boarding/externalapp/load/17E, the xId is 17E.
Body
The email address the applicant used to save the application.
The referenceId is sent to the applicant via email when they save the application.
Response
Annual revenue amount.
Average total amount of transactions in your local currency that are processed each month.
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 of $1000.
Business address.
Business address additional line.
Information about associated bank accounts.
Business city
Business country in ISO-3166-1 alpha 2 format
Check out https://en.wikipedia.org/wiki/ISO_3166-1 for reference
The business's fax number.
Numeric percent of volume processed in person. To pass validation, binperson, binweb, and binphone must total 100 together.
Numeric percent of volume processed by phone. To pass validation, binperson, binweb, and binphone must total 100 together.
Numeric percent of volume processed on web. To pass validation, binperson, binweb, and binphone must total 100 together.
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.
The application's status in the merchant boarding process. See Boarding Status Reference for more.
The application's status in the merchant boarding process. See Boarding Status Reference for more.
Business phone number.
Business start date.
Accepted formats:
- YYYY-MM-DD
- MM/DD/YYYY
Business state.
A summary of what the business sells in terms of goods or services.
Business ZIP.
List of contacts.
Timestamp of when record was created, in UTC.
The alternate or common name that this business is doing business under usually referred to as a DBA name.
Business EIN or tax ID.
A custom identifier for the paypoint, if applicable. Like entrypoint is the Payabli identifier for the merchant, externalPaypointId is a custom field you can use to include the merchant's ID from your own systems.
Events associated with the application.
High ticket amount.
Boarding application ID.
Timestamp of when record was last updated, in UTC.
Business legal name.
Business license ID or state ID number.
Business license issuing state or province.
Object containing logo file.
The business's mailing address.
Additional line for the business's mailing address.
The business's mailing address state.
Business mailing country.
The business's mailing address state.
Business mailing ZIP.
Organization ID. Unique identifier assigned to an org by Payabli.
The name of the parent organization.
List of Owners with at least a 25% ownership.
The business ownership type.
Limited Liability Company, Non-Profit Org, Partnership, Private Corp, Public Corp, Tax Exempt, Government, Sole Proprietor Auxiliary validation used internally by payment pages and components.
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.
Controls which services will be enabled for the merchant.
Information about the application's signer.
Business name in tax document. This is only relevant if a government entity has given you an alternative name to file tax documents with.
The associated boarding template's ID in Payabli.
The business website address. Include only the domain and TLD, do not enter the protocol (http/https). For example: www.example.com is acceptable.
Describes when customers are charged for goods or services. Accepted values:
When Service Provided, In Advance When goods and services are delivered.
0-7 Days, 8-14 Days, 15-30 Days, Over 30 Days Describes when goods or services are provided, from time of transaction.
30 Days or Less, 31 to 60 Days, 60+ Days Describes the business refund policy.
Exchange Only, No Refund or Exchange, More than 30 days, 30 Days or Less Was this page helpful?