Get boarding application by auth
Gets a boarding application by authentication information. This endpoint requires an application API token.
Request
- Base URL: https://api-sandbox.payabli.com/api
- URL: https://api-sandbox.payabli.com/api/Boarding/read/{xId}
- Auth: HTTP bearer
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.
Request body
Email address.
The referenceId is sent to the applicant via email when they save the application.
Response
Success
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. 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.
Business phone 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. This is found at the end of 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.
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. This value is masked in API responses.
A custom identifier for the paypoint, if applicable.
Highest 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.
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.
The business ownership type.
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.
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.
When goods and services are delivered.
Describes when goods or services are provided, from time of transaction.
Describes the business refund policy.
Custom dictionary of key:value pairs. You can use this field to store any data related to the object or for your system. If you are using custom identifiers, pass those in this object. Max length for a value is 100 characters.
{
"additionalData": {
"key1": "value1",
"key2": "value2",
"key3": "value3"
}
}
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.
Changes
No recorded changes to this operation across all 1 revision of this API.