Create a boarding token - store level

post/merchants/{merchantId}/stores/{storeId}/generatePaymentsAppBoardingToken

Creates a boarding token used to authenticate the installation of a Payments App instance on an Android device. The boarding token is created for the boardingRequestToken of the Payments App for the store identified in the path.

To make this request, your API credential must have the following role:

  • Adyen Payments App role
Endpoint destination URL
Click to copy

Path Parameters

storeIdstringRequired

The unique identifier of the store.

merchantIdstringRequired

The unique identifier of the merchant account.

Request Parameters

boardingRequestTokenstringRequired

The boardingToken request token.

Response parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

  • 200 - OK

    The request has succeeded.

    Show moreShow less
  • 400 - Bad Request

    A problem reading or understanding the request.

    Show moreShow less
  • 401 - Unauthorized

    Authentication required.

    Show moreShow less
  • 403 - Forbidden

    Insufficient permissions to process the request.

    Show moreShow less
  • 422 - Unprocessable Entity

    A request validation error.

    Show moreShow less
  • 500 - Internal Server Error

    The server could not process the request.

    Show moreShow less