integrations.sh
← all integrations

adyen.com – HopService

OpenAPI apis-guru payment

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

The Hosted onboarding API provides endpoints that you can use to generate links to Adyen-hosted pages, such as an or a . 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 .

Versioning

The Hosted onboarding API supports 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/v1/getOnboardingUrl
Homepage
https://api.apis.guru/v2/specs/adyen.com:HopService/1.json
Provider
adyen.com:HopService / HopService
OpenAPI version
3.1.0
Spec (JSON)
https://api.apis.guru/v2/specs/adyen.com/HopService/1/openapi.json
Spec (YAML)
https://api.apis.guru/v2/specs/adyen.com/HopService/1/openapi.yaml

Tools (4)

Extracted live via the executor SDK.

  • hostedOnboardingPage.postGetOnboardingUrl

    Returns 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 .

  • pciComplianceQuestionnairePage.postGetPciQuestionnaireUrl

    Returns 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 .

  • openapi.previewSpec

    Preview an OpenAPI document before adding it as a source

  • openapi.addSource

    Add an OpenAPI source and register its operations as tools