# README

Go API client for platformshostedonboardingpage

Hosted Onboarding provides endpoints for using the Hosted Onboarding Page. The related entities include account holders only. For more information, refer to our documentation.

Authentication

To connect to the HOP API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the Adyen Support Team. Then use its credentials to authenticate your request, for example:

curl
-U \"[email protected]\":\"YourWsPassword\" \\
-H \"Content-Type: application/json\" \\
...

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

Versioning

The HOP API supports versioning of its endpoints through 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

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: 6
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.GoClientExperimentalCodegen For more information, please visit https://support.adyen.com/

# Structs

ErrorFieldType struct for ErrorFieldType.
FieldType struct for FieldType.
GetOnboardingUrlRequest struct for GetOnboardingUrlRequest.
GetOnboardingUrlResponse struct for GetOnboardingUrlResponse.

# Type aliases

PlatformsHostedOnboardingPage PlatformsHostedOnboardingPage service Deprecated: Please migrate to the new Adyen For Platforms.