@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api Hosted onboarding API
@base https://cal-test.adyen.com/cal/services/Hop/v6
@version 6
@auth ApiKey X-API-Key in header | Bearer basic
@endpoints 2
@toc getOnboardingUrl(1), getPciQuestionnaireUrl(1)

@group getOnboardingUrl
@endpoint POST /getOnboardingUrl
@required {accountHolderCode: str}
@optional {collectInformation: map{bankDetails: bool, businessDetails: bool, individualDetails: bool, legalArrangementDetails: bool, pciQuestionnaire: bool, shareholderDetails: bool}, editMode: bool, mobileOAuthCallbackUrl: str, platformName: str, returnUrl: str, shopperLocale: str, showPages: map{bankDetailsSummaryPage: bool, bankVerificationPage: bool, businessDetailsSummaryPage: bool, checksOverviewPage: bool, individualDetailsSummaryPage: bool, legalArrangementsDetailsSummaryPage: bool, manualBankAccountPage: bool, shareholderDetailsSummaryPage: bool, welcomePage: bool}}
@returns(200) {invalidFields: [map], pspReference: str, redirectUrl: str, resultCode: str}
@errors {400, 401, 403, 422, 500}

@endgroup

@group getPciQuestionnaireUrl
@endpoint POST /getPciQuestionnaireUrl
@required {accountHolderCode: str}
@optional {returnUrl: str}
@returns(200) {invalidFields: [map], pspReference: str, redirectUrl: str, resultCode: str}
@errors {400, 401, 403, 422, 500}

@endgroup

@end