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
The business's processing region.
US
, CA
"US"
Business legal name.
"Sunshine Services, LLC"
The business website address. Include only the domain and TLD, do not enter the protocol (http/https). For example: www.example.com
is acceptable.
"www.example.com"
Business EIN or tax ID. This value is masked in API responses, for example XXXX6789
.
"123456789"
Business start date.
Accepted formats:
- YYYY-MM-DD
- MM/DD/YYYY
"01/01/1990"
The business's phone number.
"1234567890"
The business ownership type.
Limited Liability Company
, Non-Profit Org
, Partnership
, Private Corp
, Public Corp
, Tax Exempt
, Government
, Sole Proprietor
"Limited Liability Company"
Business address.
"123 Walnut Street"
Business city
"New Vegas"
Business state.
"FL"
Business ZIP.
"33000"
Business country in ISO-3166-1 alpha 2 format
Check out https://en.wikipedia.org/wiki/ISO_3166-1 for reference
"US"
Business Merchant Category Code (MCC). This resource lists MCC codes.
"7777"
A summary of what the business sells in terms of goods or services.
"Brick and mortar store that sells office supplies"
Describes when customers are charged for goods or services. Accepted values:
When Service Provided
, In Advance
"When Service Provided"
Describes when goods or services are provided, from time of transaction.
30 Days or Less
, 31 to 60 Days
, 60+ Days
"30 Days or Less"
When goods and services are delivered.
0-7 Days
, 8-14 Days
, 15-30 Days
, Over 30 Days
"Over 30 Days"
Describes the business refund policy.
Exchange Only
, No Refund or Exchange
, More than 30 days
, 30 Days or Less
"30 Days or Less"
Numeric percent of volume processed in person. To pass validation, binperson
, binweb
, and binphone
must total 100 together.
60
Numeric percent of volume processed by phone. To pass validation, binperson
, binweb
, and binphone
must total 100 together.
20
Numeric percent of volume processed on web. To pass validation, binperson
, binweb
, and binphone
must total 100 together.
20
Average total amount of transactions in your local currency that are processed each month.
1000
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.
1000
High ticket amount.
1000
List of contacts for the business.
Object that contains bank account details.
Controls which services will be enabled for the merchant.
Information about the application's signer.
The associated boarding template's ID in Payabli. Either templateId
or boardingLinkId
are required.
22
Boarding link ID for the application. Either templateId
or boardingLinkId
are required.
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.
"Sunshine Gutters"
Business name in tax document. This is only relevant if a government entity has given you an alternative name to file tax documents with.
"Sunshine LLC"
Business license ID or state ID number.
"2222222FFG"
Business license issuing state or province.
"CA"
The business's fax number.
"1234567890"
Business address additional line.
"Suite 103"
The business's mailing address.
"123 Walnut Street"
Additional line for the business's mailing address.
"STE 900"
The business's mail city.
"Johnson City"
The business's mailing address state.
"TN"
Business mailing ZIP.
"37615"
Business mailing country.
"US"
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.
100000
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.
"5650"
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.
"500"
Annual revenue amount.
1000
Email address for the applicant. This is used to send the applicant a boarding link.
320
"example@email.com"
Optional field for the external paypoint ID. This field is helpful if the merchant has an existing ID in your system.
"MER-103"
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.
true
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.
false
List of Owners with at least a 25% ownership.
Response
Boolean indicating whether the operation was successful. A true
value indicates success. A false
value indicates failure.
true
Response text for operation: 'Success' or 'Declined'.
"Success"
Code for the response. Learn more in API Response Codes.
1
Auxiliary validation used internally by payment pages and components.
null
The response data.
Was this page helpful?