Boarding

Get link or email a link for a boarding application

Retrieves a link and the verification code used to log into an existing boarding application. You can also use this endpoint to send a link and referenceId for an existing boarding application to an email address. The recipient can use the referenceId and email address to access and edit the application.

put/Boarding/applink/{appId}/{mail2}

Request

  • Base URL: https://api-sandbox.payabli.com/api
  • URL: https://api-sandbox.payabli.com/api/Boarding/applink/{appId}/{mail2}
  • Auth: HTTP bearer

Path parameters

appIdinteger required

Boarding application ID.

mail2string required

Email address used to access the application. If sendEmail parameter is true, a link to the application is sent to this email address.

Query parameters

sendEmailboolean

If true, sends an email that includes the link to the application to the mail2 address. Defaults to false.

Response

Success

isSuccessboolean

Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.

pageIdentifierstring

Auxiliary validation used internally by payment pages and components.

responseCodeinteger

Code for the response. Learn more in API Response Codes.

responseDataResponsedata

The object containing the response data.

responseTextstring required

Response text for operation: 'Success' or 'Declined'.

Changes

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