Create Boarding Application
Creates a boarding application in an organization. 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.
Body
Average total amount of transactions in your local currency that are processed each month.
Business address.
Business city
Business country in ISO-3166-1 alpha 2 format
Check out https://en.wikipedia.org/wiki/ISO_3166-1 for reference
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.
Business state.
A summary of what the business sells in terms of goods or services.
The business ownership type.
Limited Liability Company, Non-Profit Org, Partnership, Private Corp, Public Corp, Tax Exempt, Government, Sole Proprietor Business ZIP.
List of contacts for the business.
Object that contains bank account details.
Business EIN or tax ID.
High ticket amount.
Business legal name.
Business Merchant Category Code (MCC). This resource lists MCC codes.
The business's phone number.
The business's processing region.
US, CA Controls which services will be enabled for the merchant.
Information about the application's signer.
Business start date.
Accepted formats:
- YYYY-MM-DD
- MM/DD/YYYY
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.
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 Object that contains bank account details.
Annual revenue amount.
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 size is $500.
This is the total number of bills the business pays each month. For example, if your business pays an electric bill of $500, a internet bill of $150, and various suppliers $5,000 every motnh then your monthly bill volume would be $5,650.
Business address additional line.
Boarding link ID for the application. Either templateId or boardingLinkId are required.
The maximum amount of credit that our lending partner, has authorized to your business. It's the upper boundary on how much you can spend or owe on a credit account at any given time.
The alternate or common name that this business is doing business under usually referred to as a DBA name. Payabli strongly recommends including this information.
Optional field for the external paypoint ID. This field is helpful if the merchant has an existing ID in your system.
The business's fax number.
Business license ID or state ID number.
Business license issuing state or province.
The business's mailing address.
Additional line for the business's mailing address.
The business's mail city.
Business mailing country.
The business's mailing address state.
Business mailing ZIP.
List of Owners with at least a 25% ownership.
Email address for the applicant. This is used to send the applicant a boarding link.
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.
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. Either templateId or boardingLinkId are required.
Response
Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.
Auxiliary validation used internally by payment pages and components.
Code for the response. Learn more in API Response Codes.
The response data.
Response text for operation: 'Success' or 'Declined'.
Was this page helpful?