Boarding

Create multi-product boarding application

Creates a new boarding application linked to an existing paypoint as part of the multi-product boarding flow. Use this endpoint to add new services to a paypoint without creating a duplicate record. The system copies eligible business, contact, banking, and address data from the paypoint to the new application based on 1:1 field matching. The merchant only needs to provide fields that are specific to the new service. See the Multi-product boarding guide for the full flow.

post/Boarding/applications

Request

  • Base URL: https://api-sandbox.payabli.com/api
  • URL: https://api-sandbox.payabli.com/api/Boarding/applications
  • Auth: HTTP bearer

Request body

paypointIdinteger required

ID of the existing paypoint to link to this application.

templateIdinteger required

ID of the boarding template to use for the new application.

recipientEmailstring required

Email address where the boarding link is sent. Required. If you don't want to email the merchant, send to an internal address and use returnBoardingAccessInfoInLine to retrieve the link from the response instead.

returnBoardingAccessInfoInLineboolean

When true, returns the boarding access information directly in the response.

onCreatestring[]

Additional actions to trigger when the application is created. Currently only submitApplication is supported, which automatically submits the application on creation and skips the draft state.

Response

Success

responseCodeinteger

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

pageIdentifierstring

Auxiliary validation used internally by payment pages and components.

roomIdinteger

Field not in use on this endpoint. It always returns 0.

isSuccessboolean

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

responseTextstring required

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

Changes

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