API referencePay Ops endpointsBoardingBoarding apps

Get app by ID

Retrieves the details for a boarding application by ID.

Authentication

requestTokenstring
API Key authentication via header

Path parameters

appIdintegerRequired
Boarding application ID.

Response

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

The average transaction size that the business expects to process. For example, if you process 10,000amonthacross10transactions,that′sanaverageticketof10,000 a month across 10 transactions, that's an average ticket of 1000.

bAddress1string
Business address.
bAddress2string
Business address additional line.
bankDatalist of objects
Information about associated bank accounts.
bCitystring
Business city
bCountrystring

Business country in ISO-3166-1 alpha 2 format
Check out https://en.wikipedia.org/wiki/ISO_3166-1 for reference

bFaxstring
The business's fax number.
binPersoninteger

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

binPhoneinteger

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

binWebinteger

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

boardingLinkIdinteger

The boarding link ID. Can be found at the end of the boarding link reference name. The boarding link reference name. For example https://boarding.payabli.com/boarding/app/myorgaccountname-00091. The ID is 91.

boardingStatusinteger

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

boardingSubStatusinteger

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

bPhonestring
Business phone number.
bStartdatestring

Business start date.
Accepted formats:

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

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

externalPaypointIdstring

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

List of Owners with at least a 25% ownership.

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

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

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
serviceDataobject
Controls which services will be enabled for the merchant.
signerobject
Information about the application's signer.
taxfillnamestring
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
The associated boarding template's ID in Payabli.
websiteAddressstring

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

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

Allowed values:
whendeliveredenum
When goods and services are delivered.
Allowed values:
whenProvidedenum
Describes when goods or services are provided, from time of transaction.
Allowed values:
whenrefundenum
Describes the business refund policy.
Allowed values:

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error
503
Service Unavailable Error