API Basics
Pay In Endpoints
- MoneyIn
- Subscription
- TokenStorage
- Invoice
- LineItem
- PaymentLink
- PaymentMethodDomain
- HostedPaymentPages
- Cloud
- Wallet: Apple Pay
Pay Out Endpoints
- MoneyOut
- Bill
Pay Ops Endpoints
- Templates
- Boarding
- Chargebacks and ACH Returns
- Entities
- Notification
- Query
- Statistic
- Export
- Import
Object Models
- Object Model References
Get Boarding Application by ID
Retrieves the details for a boarding application by ID.
Authorizations
Most endpoints require an organization token. Some endpoints require an application token, and those endpoints are noted.
Path Parameters
Boarding application ID.
Response
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.
Business address additional line.
Information about associated bank accounts.
Masked account number for bank account.
Describes whether the bank account is used for deposits or withdrawals in Payabli:
0: Deposit1: Withdrawal2: Deposit and withdrawal
The accountholder's name.
Describes whether the bank is a personal or business account.
Personal, Business Name of bank for account.
The bank's ID in Payabli.
Routing number of bank account.
Type of bank account: Checking or Savings.
Checking, Savings Business city
Business country in ISO-3166-1 alpha 2 format
Check out https://en.wikipedia.org/wiki/ISO_3166-1 for reference
The business's fax 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. 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.
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.
When true, the element is read-only.
When true, the element is required.
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
When true, the element is required.
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
When true, the element is required.
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
When true, the element is required.
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
When true, the element is required.
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
When true, the element is required.
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
When true, the element is required.
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
When true, the element is required.
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
When true, the element is required.
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
When true, the element is required.
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
When true, the element is required.
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
When true, the element is required.
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
When true, the element is required.
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
When true, the element is required.
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
When true, the element is required.
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
When true, the element is required.
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
When true, the element is required.
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
When true, the element is required.
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
When true, the element is required.
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
When true, the element is required.
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
When true, the element is required.
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
When true, the element is required.
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
When true, the element is required.
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
When true, the element is required.
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
When true, the element is required.
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
When true, the element is required.
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
When true, the element is required.
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
When true, the element is required.
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
When true, the element is required.
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
When true, the element is required.
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
When true, the element is required.
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
When true, the element is required.
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
When true, the element is required.
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
When true, the element is required.
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
When true, the element is required.
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
When true, the element is required.
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
When true, the element is required.
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
When true, the element is required.
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
When true, the element is required.
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
When true, the element is required.
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
When true, the element is required.
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
When true, the element is required.
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
When true, the element is required.
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
When true, the element is required.
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
When true, the element is required.
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
When true, the element is required.
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
When true, the element is required.
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
When true, the element is required.
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
When true, the element is required.
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
When true, the element is required.
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
When true, the element is required.
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
When true, the element is required.
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
When true, the element is required.
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
When true, the element is required.
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
When true, the element is required.
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
When true, the element is required.
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
When true, the element is required.
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
When true, the element is required.
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
When true, the element is required.
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
When true, the element is required.
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
When true, the element is required.
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
When true, the element is required.
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
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.
Zip file containing attachments.
Business EIN or tax ID.
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.
Events associated with the application.
High 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.
Object containing logo file.
Content of file, Base64-encoded Ignored if furl is specified. Max upload size is 30 MB.
The name of the attached file.
The MIME type of the file (if content is provided)
pdf, doc, docx, jpg, jpeg, png, gif, txt Optional url provided to show or download the file remotely
The business's mailing address.
Additional line for the business's mailing address.
The business's mailing address state.
Business mailing country.
Timestamp of when record was created, in UTC.
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.
List of Owners with at least a 25% ownership.
Owner street address.
Owner address city.
Owner address country in ISO-3166-1 alpha 2 format
Check out https://en.wikipedia.org/wiki/ISO_3166-1 for reference
Owner driver's license State. Payabli strongly recommends including this.
Owner address state.
Owner's date of birth.
Owner driver's License. Payabli strongly recommends including this.
Owner email.
Person who is registered as the beneficial owner of the business. This is a combination of first and last name.
Percentage of ownership the person holds, in integer format.
Owner phone 1.
Owner phone 2.
The relevant identifier for the person such as a Social Security Number.
The job title of the person such as CEO or director.
Owner address ZIP.
The business ownership type.
Limited Liability Company, Non-Profit Org, Partnership, Private Corp, Public Corp, Tax Exempt, Government, Sole Proprietor 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.
Controls which services will be enabled for the merchant.
CCD is an ACH SEC Code that can be used in ACH transactions by the user that indicates the transaction is a Corporate Credit or Debit Entry. Options are: true and false
PPD is an ACH SEC Code that can be used in ACH transactions by the user that indicates the transaction is a Prearranged Payment and Deposit.
Web is an ACH SEC Code that can be used in ACH transactions by the user that indicates the transaction is a Internet Initiated/Mobile Entry Options are true and false.
Determines whether American Express is accepted.
Determines whether Discover is accepted.
Determines whether MasterCard is accepted.
Determines whether Visa is accepted.
Information about the application's signer.
The signer's acceptance status. A true or false indicating an acceptance to the terms of service with the root org or provider.
The signer's address.
Additional line for the signer's address.
The signer's city.
The signer's country in ISO-3166-1 alpha 2 format. \r\nCheck out https://en.wikipedia.org/wiki/ISO_3166-1 for reference.
The signer's date of birth.
The signer's email address.
The signer's name.
The signer's phone number.
Reference to the signed document.
The signer's ID. This is automatically generated by Payabli.
The signer's SSN.
The signer's state.
The signer's zip code.
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. Accepted values:
When Service Provided, In Advance When goods and services are delivered.
0-7 Days, 8-14 Days, 15-30 Days, Over 30 Days Describes when goods or services are provided, from time of transaction.
30 Days or Less, 31 to 60 Days, 60+ Days Describes the business refund policy.
Exchange Only, No Refund or Exchange, More than 30 days, 30 Days or Less Was this page helpful?