mirror of
https://github.com/gcatanese/adyen-openapi.git
synced 2026-03-10 08:01:24 +00:00
spec release
This commit is contained in:
Adyen Automation
@@ -9,7 +9,7 @@
|
||||
"version" : "1",
|
||||
"x-publicVersion" : true,
|
||||
"title" : "Hosted onboarding API",
|
||||
"description" : "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms) instead.\n\nThe Hosted onboarding API provides endpoints that you can use to generate links to Adyen-hosted pages, such as an [onboarding page](https://docs.adyen.com/marketplaces-and-platforms/classic/hosted-onboarding-page) or a [PCI compliance questionnaire](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners). You can provide these links to your account holders so that they can complete their onboarding.\n\n## Authentication\nYour 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:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws@MarketPlace.YOUR_PLATFORM_ACCOUNT\":\"YOUR_WS_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Hosted onboarding API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://cal-test.adyen.com/cal/services/Hop/v1/getOnboardingUrl\n```",
|
||||
"description" : "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/adyen-for-platforms-model) instead.\n\nThe Hosted onboarding API provides endpoints that you can use to generate links to Adyen-hosted pages, such as an [onboarding page](https://docs.adyen.com/classic-platforms/hosted-onboarding-page) or a [PCI compliance questionnaire](https://docs.adyen.com/classic-platforms/platforms-for-partners). You can provide these links to your account holders so that they can complete their onboarding.\n\n## Authentication\nYour 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:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws@MarketPlace.YOUR_PLATFORM_ACCOUNT\":\"YOUR_WS_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Hosted onboarding API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://cal-test.adyen.com/cal/services/Hop/v1/getOnboardingUrl\n```",
|
||||
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
|
||||
"contact" : {
|
||||
"name" : "Adyen Developer Experience team",
|
||||
@@ -31,7 +31,7 @@
|
||||
"Hosted Onboarding Page"
|
||||
],
|
||||
"summary" : "Get a link to a Adyen-hosted onboarding page",
|
||||
"description" : "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](https://docs.adyen.com/marketplaces-and-platforms/classic/collect-verification-details/hosted-onboarding-page). ",
|
||||
"description" : "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](https://docs.adyen.com/classic-platforms/collect-verification-details/hosted-onboarding-page). ",
|
||||
"operationId" : "post-getOnboardingUrl",
|
||||
"x-sortIndex" : 1,
|
||||
"x-methodName" : "getOnboardingUrl",
|
||||
@@ -134,7 +134,7 @@
|
||||
"PCI Compliance Questionnaire Page"
|
||||
],
|
||||
"summary" : "Get a link to a PCI compliance questionnaire",
|
||||
"description" : "Returns a link to a PCI compliance questionnaire that you can send to your account holder.\n > You should only use this endpoint if you have a [partner platform setup](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners).",
|
||||
"description" : "Returns a link to a PCI compliance questionnaire that you can send to your account holder.\n > You should only use this endpoint if you have a [partner platform setup](https://docs.adyen.com/classic-platforms/platforms-for-partners).",
|
||||
"operationId" : "post-getPciQuestionnaireUrl",
|
||||
"x-sortIndex" : 1,
|
||||
"x-methodName" : "getPciQuestionnaireUrl",
|
||||
@@ -238,27 +238,27 @@
|
||||
"additionalProperties" : false,
|
||||
"properties" : {
|
||||
"bankDetails" : {
|
||||
"description" : "Indicates whether [bank account details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/accepted-data-format/#bank-accounts) must be collected. Default is **true**.",
|
||||
"description" : "Indicates whether [bank account details](https://docs.adyen.com/classic-platforms/verification-process/accepted-data-format/#bank-accounts) must be collected. Default is **true**.",
|
||||
"type" : "boolean"
|
||||
},
|
||||
"businessDetails" : {
|
||||
"description" : "Indicates whether [business details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/accepted-data-format/#organizations) must be collected. Default is **true**.",
|
||||
"description" : "Indicates whether [business details](https://docs.adyen.com/classic-platforms/verification-process/accepted-data-format/#organizations) must be collected. Default is **true**.",
|
||||
"type" : "boolean"
|
||||
},
|
||||
"individualDetails" : {
|
||||
"description" : "Indicates whether [individual details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/accepted-data-format/#individuals) must be collected. Default is **true**.",
|
||||
"description" : "Indicates whether [individual details](https://docs.adyen.com/classic-platforms/verification-process/accepted-data-format/#individuals) must be collected. Default is **true**.",
|
||||
"type" : "boolean"
|
||||
},
|
||||
"legalArrangementDetails" : {
|
||||
"description" : "Indicates whether [legal arrangement details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks/legal-arrangements) must be collected. Default is **true**.",
|
||||
"description" : "Indicates whether [legal arrangement details](https://docs.adyen.com/classic-platforms/verification-checks/legal-arrangements) must be collected. Default is **true**.",
|
||||
"type" : "boolean"
|
||||
},
|
||||
"pciQuestionnaire" : {
|
||||
"description" : "Indicates whether answers to a [PCI questionnaire](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#onboard-partner-platform) must be collected. Applies only to partner platforms. Default is **true**.",
|
||||
"description" : "Indicates whether answers to a [PCI questionnaire](https://docs.adyen.com/classic-platforms/platforms-for-partners#onboard-partner-platform) must be collected. Applies only to partner platforms. Default is **true**.",
|
||||
"type" : "boolean"
|
||||
},
|
||||
"shareholderDetails" : {
|
||||
"description" : "Indicates whether [shareholder details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/accepted-data-format/#individuals) must be collected. Defaults to **true**.",
|
||||
"description" : "Indicates whether [shareholder details](https://docs.adyen.com/classic-platforms/verification-process/accepted-data-format/#individuals) must be collected. Defaults to **true**.",
|
||||
"type" : "boolean"
|
||||
}
|
||||
},
|
||||
@@ -477,7 +477,7 @@
|
||||
"type" : "string"
|
||||
},
|
||||
"collectInformation" : {
|
||||
"description" : "Contains indicators whether the page should only collect information for specific [KYC checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks). By default, the page collects information for all KYC checks that apply to the [legal entity type](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#legal-entity-types).",
|
||||
"description" : "Contains indicators whether the page should only collect information for specific [KYC checks](https://docs.adyen.com/classic-platforms/verification-checks). By default, the page collects information for all KYC checks that apply to the [legal entity type](https://docs.adyen.com/classic-platforms/account-holders-and-accounts#legal-entity-types).",
|
||||
"$ref" : "#/components/schemas/CollectInformation"
|
||||
},
|
||||
"editMode" : {
|
||||
@@ -497,7 +497,7 @@
|
||||
"type" : "string"
|
||||
},
|
||||
"shopperLocale" : {
|
||||
"description" : "The language to be used in the page, specified by a combination of a language and country code. For example, **pt-BR**. \n\nIf 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.\n\nFor a list of supported languages, refer to [Change the page language](https://docs.adyen.com/marketplaces-and-platforms/classic/hosted-onboarding-page/customize-experience#change-page-language).",
|
||||
"description" : "The language to be used in the page, specified by a combination of a language and country code. For example, **pt-BR**. \n\nIf 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.\n\nFor 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).",
|
||||
"type" : "string"
|
||||
},
|
||||
"showPages" : {
|
||||
|
||||
Reference in New Issue
Block a user