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 Link by Reference
Retrieves the details for a boarding link, by reference name. This endpoint requires an application API token.
Authorizations
Most endpoints require an organization token. Some endpoints require an application token, and those endpoints are noted.
Path Parameters
The boarding link reference name. You can find this at the end of the boarding link URL. For example https://boarding.payabli.com/boarding/app/myorgaccountname-00091
Response
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
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
Organization ID. Unique identifier assigned to an org by Payabli.
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.
Was this page helpful?