Update app
Updates a boarding application by ID. This endpoint requires an application API token.
Path parameters
Boarding application ID.
Headers
Request
Controls which services will be enabled for the merchant.
Annual revenue amount.
Array of fileContent
objects with attached documents. Max upload size is 30 MB.
Average total amount of transactions in your local currency that are processed each month.
Business address.
Business address additional line.
Object that contains bank account details.
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.
Business ZIP.
List of contacts.
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, for example XXXX6789
.
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.
The business’s fax number.
High 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.
List of Owners with at least a 25% ownership.
The total number of bills the business pays each month. For example, if your business pays an electric bill of 150, and various suppliers 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 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 bill you will pay through our service. For example, if your business paid for 3 bills each month for 1000, and 5000.
The business’s phone number.
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.
Information about the application’s signer.
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 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 goods and services are delivered.
Describes when goods or services are provided, from time of transaction.
Describes the business refund policy.
Response
Success
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’.