Skip to navigation
APIPay Ops endpointsBoardingLegacy boardingBoarding apps (deprecated)

Create multi-product boarding app

Deprecated
View as MarkdownOpen in Claude

Legacy boarding is deprecated and will be sunset in Q2 2027. Use Create an application for a paypoint that’s already boarded instead. See Request more services with the API.

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.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

OR
requestTokenstring

Long-lived API token sent in the requestToken header. See API token authentication.

Request

This endpoint expects an object.
paypointIdlongRequired
ID of the existing paypoint to link to this application.
templateIdlongRequired
ID of the boarding template to use for the new application.
recipientEmailstringRequired

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.

returnBoardingAccessInfoInLinebooleanOptional

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

onCreatelist of stringsOptional

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
responseTextstring

Response text for operation: ‘Success’ or ‘Declined’.

responseCodeintegerOptional

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

pageIdentifierstringOptional
Auxiliary validation used internally by payment pages and components.
roomIdlongOptional

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

isSuccessbooleanOptional

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

responseDataobjectOptional

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error
503
Service Unavailable Error