Hosted onboarding API
This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
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/getOnboardingUrlEndpoints 2
Hosted Onboarding Page
- POSTGet a link to a Adyen-hosted onboarding page
/getOnboardingUrlReturns a link to an Adyen-hosted onboarding page (HOP) that you can send to your account holder. For more information on how to use HOP, refer to Hosted…
PCI Compliance Questionnaire Page
- POSTGet a link to a PCI compliance questionnaire
/getPciQuestionnaireUrlReturns a link to a PCI compliance questionnaire that you can send to your account holder. > You should only use this endpoint if you have a partner platform…
API details
- Base URL
https://cal-test.adyen.com/cal/services/Hop/v6- Authentication
- An API key in the X-API-Key header
HTTP Basic authentication (username and password) - Operations
- 2 operations on 2 pathsPOST 2
- Main resources
- Hosted Onboarding Page 1PCI Compliance Questionnaire Page 1
- Response formats
application/json- Description format
- OpenAPI 3.1.0, API version
6 - Links
- OpenAPI document · Terms of service · Support
- Listed from
- Adyen's published OpenAPI description (Adyen/adyen-openapi) (MIT)
How to test the Hosted onboarding API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Hosted onboarding API collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the X-API-Key header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Get a link to a Adyen-hosted onboarding page” (POST /getOnboardingUrl), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Hosted onboarding API?
This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration… It is listed under Payments and has 2 endpoints.
Who publishes the Hosted onboarding API?
It is listed from Adyen's public API description (an OpenAPI document), not published by Adyen on Swastik Codes. Anyone who controls adyen.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Hosted onboarding API?
Requests go to https://cal-test.adyen.com/cal/services/Hop/v6. Endpoint paths are added to this base URL.
How do I authenticate with the Hosted onboarding API?
It accepts 2 methods: an API key in the X-API-Key header; HTTP Basic authentication (username and password).
How many endpoints does the Hosted onboarding API have?
2 operations on 2 paths (2 POST). The largest groups are Hosted Onboarding Page, PCI Compliance Questionnaire Page.
Is forking the Hosted onboarding API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.