Boarding

Get boarding link by template ID

Get details for a boarding link using the boarding template ID. This endpoint requires an application API token.

get/Boarding/linkbyTemplate/{templateId}

Request

  • Base URL: https://api-sandbox.payabli.com/api
  • URL: https://api-sandbox.payabli.com/api/Boarding/linkbyTemplate/{templateId}
  • Auth: HTTP bearer

Path parameters

templateIdnumber double required

The boarding template ID. You can find this at the end of the boarding template URL in the Payabli Portal. Example: https://partner-sandbox.payabli.com/myorganization/boarding/edittemplate/80. Here, the template ID is 80.

Response

Success

acceptOauthboolean
acceptRegisterboolean
entryAttributesstring
idinteger
orgIdinteger

Organization ID. Unique identifier assigned to an org by Payabli.

pageIdentifier:string

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.

referenceNamestring
referenceTemplateIdinteger
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.

Changes

No recorded changes to this operation across all 1 revision of this API.