APIPay Ops endpointsBoardingBoarding apps

Get application via auth token

Gets a boarding application by authentication information. This endpoint requires an application API token.

Authentication

requestTokenstring
API Key authentication via header

Path parameters

xIdstringRequired

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

This endpoint expects an object.
emailstringOptionalformat: "email"<=320 characters
The email address the applicant used to save the application.
referenceIdstringOptional
The referenceId is sent to the applicant via email when they save the application.

Response

Success
annualRevenuedouble or null
Annual revenue amount.
averageMonthlyVolumedouble or null
Average total amount of transactions in your local currency that are processed each month.
averageTicketAmountdouble or null

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.

bAddress1string or null
Business address. This must be a physical address, not a P.O. box.
bAddress2string or null
Business address additional line. If used, this must be the physical address of the business, not a P.O. box.
bankDatalist of objects or null
Information about associated bank accounts.
bCitystring or null
Business city
bCountrystring or null
Business country in ISO-3166-1 alpha 2 format. See: https://en.wikipedia.org/wiki/ISO_3166-1 for more information.
bFaxstring or null
The business's fax number.
binPersoninteger or null

Numeric percent of volume processed in person. To pass validation, binperson, binweb, and binphone must total 100 together.

binPhoneinteger or null

Numeric percent of volume processed by phone. To pass validation, binperson, binweb, and binphone must total 100 together.

binWebinteger or null

Numeric percent of volume processed on web. To pass validation, binperson, binweb, and binphone must total 100 together.

boardingLinkIdinteger or null

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.

boardingStatusinteger or null

The application’s status in the merchant boarding process. See Boarding Status Reference for more.

boardingSubStatusinteger or null

The application’s status in the merchant boarding process. See Boarding Status Reference for more.

bPhonestring or null
Business phone number.
bStartdatestring or null

Business start date. Accepted formats:

  • YYYY-MM-DD

  • MM/DD/YYYY

bStatestring or null
Business state.
bSummarystring or null
A summary of what the business sells in terms of goods or services.
builderDataobject or null
bZipstring or null
Business ZIP.
contactDatalist of objects or null
List of contacts.
createdAtdatetime or null
Timestamp of when record was created, in UTC.
dbaNamestring or null
The alternate or common name that this business is doing business under usually referred to as a DBA name.
documentsRefobject or null
einstring or null

Business EIN or tax ID. This value is masked in API responses, for example XXXX6789.

externalPaypointIdstring or null

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.

generalEventslist of objects or null
Events associated with the application.
highTicketAmountdouble or null
High ticket amount.
idApplicationinteger or null
Boarding application ID.
lastModifieddatetime or null
Timestamp of when record was last updated, in UTC.
legalNamestring or null
Business legal name.
licensestring or null
Business license ID or state ID number.
licenseStatestring or null
Business license issuing state or province.
mAddress1string or null
The business's mailing address.
mAddress2string or null
Additional line for the business's mailing address.
mccidstring or null
mCitystring or null
The business's mailing address state.
mCountrystring or null
Business mailing country.
mStatestring or null
The business's mailing address state.
mZipstring or null
Business mailing ZIP.
orgIdlong or null
Organization ID. Unique identifier assigned to an org by Payabli.
orgParentNamestring or null
The name of the parent organization.
ownerDatalist of objects or null

List of Owners with at least a 25% ownership.

ownTypeenum or null
The business ownership type.
pageidentifierstring or null
Auxiliary validation used internally by payment pages and components.
recipientEmailNotificationboolean or null

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.

resumableboolean or null

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.

salesCodestring or null
serviceDataobject or null
Controls which services will be enabled for the merchant.
signerobject or null
Information about the application's signer.
taxfillnamestring or null
Business name in tax document. This is only relevant if a government entity has given you an alternative name to file tax documents with.
templateIdlong or null
The associated boarding template's ID in Payabli.
websiteAddressstring or null

The business website address. Include only the domain and TLD, do not enter the protocol (http/https). For example: www.example.com is acceptable.

whenchargedenum or null

Describes when customers are charged for goods or services. Accepted values:

Allowed values:
whendeliveredenum or null
When goods and services are delivered.
Allowed values:
whenProvidedenum or null
Describes when goods or services are provided, from time of transaction.
Allowed values:
whenrefundenum or null
Describes the business refund policy.
Allowed values:
additionalDatastring or null
Custom dictionary of key:value pairs. You can use this field to store any data related to the object or for your system. Example usage: ```json { "additionalData": { "key1": "value1", "key2": "value2", "key3": "value3" } } ```
RepCodestring or null<=50 characters
Sales representative code. This is an optional field that can be used to track the sales representative associated with the application.
RepNamestring or null<=50 characters
Sales representative name. This is an optional field that can be used to track the sales representative associated with the application.
RepOfficestring or null<=50 characters
Sales representative office location. This is an optional field that can be used to track the sales representative office associated with the application.

Errors