ADadyen
Hosted Onboarding Page

Get a link to a Adyen-hosted onboarding page

Changed on

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 Hosted onboarding.

post/getOnboardingUrl

Request

  • Base URL
    https://cal-test.adyen.com/cal/services/Hop/v5
  • URL
    https://cal-test.adyen.com/cal/services/Hop/v5/getOnboardingUrl
  • Auth
    • HTTP basic
    • or API key in header X-API-Key

Request body

accountHolderCodestring required

The account holder code you provided when you created the account holder.

editModeboolean

Indicates if editing checks is allowed even if all the checks have passed.

mobileOAuthCallbackUrlstring

The URL to which the account holder is redirected after completing an OAuth authentication with a bank through Trustly/PayMyBank.

platformNamestring

The platform name which will show up in the welcome page.

returnUrlstring

The URL where the account holder will be redirected back to after they complete the onboarding, or if their session times out. Maximum length of 500 characters. If you don't provide this, the account holder will be redirected back to the default return URL configured in your platform account.

shopperLocalestring

The language to be used in the page, specified by a combination of a language and country code. For example, pt-BR.

If not specified in the request or if the language is not supported, the page uses the browser language. If the browser language is not supported, the page uses en-US by default.

For a list of supported languages, refer to Change the page language.

Response

OK - the request has succeeded.

pspReferencestring

The reference of a request. Can be used to uniquely identify the request.

redirectUrlstring

The URL to the Hosted Onboarding Page where you should redirect your sub-merchant. This URL must be used within 30 seconds and can only be used once.

resultCodestring

The result code.

Changes

  • v5ff4162596851Revision changes
    • warning

      added the new linkedViasVirtualAccount enum value to the /// response property for the response status

  • v56c83af821d5eRevision changes
    • warning

      added the new payoutMethod enum value to the /// response property for the response status