{"note":"OpenAPI conversion -- returning structured metadata","name":"adyen-com-hopservice","description":"Hosted onboarding API","version":"6","base_url":"https://cal-test.adyen.com/cal/services/Hop/v6","endpoints":2,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Hosted onboarding API\n@base https://cal-test.adyen.com/cal/services/Hop/v6\n@version 6\n@auth ApiKey X-API-Key in header | Bearer basic\n@endpoints 2\n@toc getOnboardingUrl(1), getPciQuestionnaireUrl(1)\n\n@group getOnboardingUrl\n@endpoint POST /getOnboardingUrl\n@desc Get a link to a Adyen-hosted onboarding page\n@required {accountHolderCode: str # The account holder code you provided when you created the account holder.}\n@optional {collectInformation: map{bankDetails: bool, businessDetails: bool, individualDetails: bool, legalArrangementDetails: bool, pciQuestionnaire: bool, shareholderDetails: bool}, editMode: bool # Indicates if editing checks is allowed even if all the checks have passed., mobileOAuthCallbackUrl: str # The URL to which the account holder is redirected after completing an OAuth authentication with a bank through Trustly/PayMyBank., platformName: str # The platform name which will show up in the welcome page., returnUrl: str # 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., shopperLocale: str # 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](https://docs.adyen.com/classic-platforms/hosted-onboarding-page/customize-experience#change-page-language)., showPages: map{bankDetailsSummaryPage: bool, bankVerificationPage: bool, businessDetailsSummaryPage: bool, checksOverviewPage: bool, individualDetailsSummaryPage: bool, legalArrangementsDetailsSummaryPage: bool, manualBankAccountPage: bool, shareholderDetailsSummaryPage: bool, welcomePage: bool}}\n@returns(200) {invalidFields: [map], pspReference: str, redirectUrl: str, resultCode: str} # OK - the request has succeeded.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n@example_request {\"accountHolderCode\":\"CODE_OF_ACCOUNT_HOLDER\",\"returnUrl\":\"https://your.return-url.com/?submerchant=123\"}\n\n@endgroup\n\n@group getPciQuestionnaireUrl\n@endpoint POST /getPciQuestionnaireUrl\n@desc Get a link to a PCI compliance questionnaire\n@required {accountHolderCode: str # The account holder code you provided when you created the account holder.}\n@optional {returnUrl: str # The URL where the account holder will be redirected back to after they fill out the questionnaire, or if their session times out. Maximum length of 500 characters.}\n@returns(200) {invalidFields: [map], pspReference: str, redirectUrl: str, resultCode: str} # OK - the request has succeeded.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n@example_request {\"accountHolderCode\":\"CODE_OF_ACCOUNT_HOLDER\",\"returnUrl\":\"https://your.return-url.com/?submerchant=123\"}\n\n@endgroup\n\n@end\n"}