Hosted onboarding API

This API is used for the classic integration. If you are just starting your implementation, refer to our new integration guide instead.

The Hosted onboarding API provides endpoints that you can use to generate links to Adyen-hosted pages, such as an onboarding page or a PCI compliance questionnaire. You can provide these links to your account holders so that they can complete their onboarding.

Authentication

Your Adyen contact will provide your API credential and an API key. To connect to the API, add an X-API-Key header with the API key as the value, for example:

curl
-H "Content-Type: application/json" \
-H "X-API-Key: YOUR_API_KEY" \
...

Alternatively, you can use the username and password to connect to the API using basic authentication. For example:

curl
-U "ws@MarketPlace.YOUR_PLATFORM_ACCOUNT":"YOUR_WS_PASSWORD" \
-H "Content-Type: application/json" \
...

When going live, you need to generate new web service user credentials to access the live endpoints.

Versioning

The Hosted onboarding API supports versioning using a version suffix in the endpoint URL. This suffix has the following format: “vXX”, where XX is the version number.

For example:

https://cal-test.adyen.com/cal/services/Hop/v6/getOnboardingUrl

Use this page to mock Hosted onboarding API in your testing and development.

Run our mock API sample using the open source WireMock library, or in the free edition of WireMock Cloud. You'll have a working API server simulating the behavior of Hosted onboarding API, which will allow you to keep building and testing even if the actual API you isn't currently available.