Update boarding application
Updates a boarding application by ID. This endpoint requires an application API token.
Request
- Base URL: https://api-sandbox.payabli.com/api
- URL: https://api-sandbox.payabli.com/api/Boarding/app/{appId}
- Auth: HTTP bearer
Path parameters
Boarding application ID.
Request body
Annual revenue amount.
Average total amount of transactions in your local currency that are processed each month.
Business address. This must be a physical address, not a P.O. box.
Business address additional line. If used, this must be the physical address of the business, not a P.O. box.
Business city.
Business country in ISO-3166-1 alpha 2 format. See ISO 3166-1 for more information.
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.
Business ZIP.
The alternate or common name that this business is doing business under, usually referred to as a DBA name.
Business EIN or tax ID. This value is masked in API responses.
A custom identifier for the paypoint, if applicable.
The business's fax number.
Highest ticket amount.
Business legal name.
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.
Business Merchant Category Code (MCC). This resource lists MCC codes.
The business's mail city.
Business mailing country.
The business's mailing address state.
Business mailing ZIP.
Organization ID. Unique identifier assigned to an org by Payabli.
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 suppliers $5,000 every month then your monthly bill volume would be $5,650.
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.
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 or owe on a credit account at any given time.
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 respectively, then your highest ticket is $5000.
The business's phone number.
Email address.
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 start date. Accepted formats:
- YYYY-MM-DD
- MM/DD/YYYY
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 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.
When goods and services are delivered.
Describes when goods or services are provided, from time of transaction.
Describes the business refund policy.
Sales representative code. This is an optional field that can be used to track the sales representative associated with the application.
Sales representative name. This is an optional field that can be used to track the sales representative associated with the application.
Sales representative office location. This is an optional field that can be used to track the sales representative office associated with the application.
Actions to take when the application is created. The only currently supported option is submitApplication. Use this when you have collected eSignature elsewhere or are adding additional locations for an applicant, or when you want to submit an application via API with one call without using the hosted boarding UI or embedded boarding components. Pass the value as an array, for example ["submitApplication"].
Response
Success
Code for the response. Learn more in API Response Codes.
Auxiliary validation used internally by payment pages and components.
Describes the room ID. Only in use on Boarding endpoints, returns 0 when not applicable.
Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.
Response text for operation: 'Success' or 'Declined'.
Changes
No recorded changes to this operation across all 1 revision of this API.