jlengrand/adyen-openapi
1
0
Fork 0
mirror of https://github.com/gcatanese/adyen-openapi.git synced 2026-03-10 08:01:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

spec release

Browse Source
This commit is contained in:
Adyen Automation
2023-03-22 10:31:00 +00:00
parent 51b39b09b2
commit 68a6f20331
40 changed files with 3278 additions and 2230 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
json/HopService-v1.json
View File

@@ -10,7 +10,7 @@
"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```",
"x-timestamp" : "2022-07-28T16:19:59Z",
"x-timestamp" : "2023-03-22T11:13:03Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
@@ -41,6 +41,7 @@
"operationId" : "post-getOnboardingUrl",
"x-groupName" : "Hosted Onboarding Page",
"x-sortIndex" : 1,
"x-methodName" : "getOnboardingUrl",
"security" : [
{
"BasicAuth" : [
@@ -144,6 +145,7 @@
"operationId" : "post-getPciQuestionnaireUrl",
"x-groupName" : "PCI Compliance Questionnaire Page",
"x-sortIndex" : 1,
"x-methodName" : "getPciQuestionnaireUrl",
"security" : [
{
"BasicAuth" : [
@@ -266,7 +268,8 @@
"description" : "Indicates whether [shareholder details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks/identity-check) must be collected. Defaults to **true**.",
"type" : "boolean"
}
}
},
"type" : "object"
},
"ErrorFieldType" : {
"properties" : {
@@ -283,7 +286,8 @@
"description" : "The type of error field.",
"$ref" : "#/components/schemas/FieldType"
}
}
},
"type" : "object"
},
"FieldType" : {
"properties" : {
@@ -322,6 +326,7 @@
"city",
"companyRegistration",
"constitutionalDocument",
"controller",
"country",
"countryCode",
"currency",
@@ -407,6 +412,7 @@
"shareholderCodeAndSignatoryCode",
"shareholderCodeOrSignatoryCode",
"shareholderType",
"shareholderTypes",
"shopperInteraction",
"signatory",
"signatoryCode",
@@ -456,7 +462,8 @@
"description" : "The code of the shareholder that the field belongs to. If empty, the field belongs to an account holder.",
"type" : "string"
}
}
},
"type" : "object"
},
"GetOnboardingUrlRequest" : {
"properties" : {
@@ -472,6 +479,10 @@
"description" : "Indicates if editing checks is allowed even if all the checks have passed.",
"type" : "boolean"
},
"mobileOAuthCallbackUrl" : {
"description" : "The URL to which the account holder is redirected after completing an OAuth authentication with a bank through Trustly/PayMyBank.",
"type" : "string"
},
"platformName" : {
"description" : "The platform name which will show up in the welcome page.",
"type" : "string"
@@ -491,7 +502,8 @@
},
"required" : [
"accountHolderCode"
]
],
"type" : "object"
},
"GetOnboardingUrlResponse" : {
"properties" : {
@@ -519,7 +531,8 @@
"description" : "Indicates whether the request is processed asynchronously. Depending on the request's platform settings, the following scenarios may be applied:\n* **true**: The request is queued and will be executed when the providing service is available in the order in which the requests are received.\n* **false**: The processing of the request is immediately attempted; it may result in an error if the providing service is unavailable.",
"type" : "boolean"
}
}
},
"type" : "object"
},
"GetPciUrlRequest" : {
"properties" : {
@@ -534,7 +547,8 @@
},
"required" : [
"accountHolderCode"
]
],
"type" : "object"
},
"GetPciUrlResponse" : {
"properties" : {
@@ -562,7 +576,8 @@
"description" : "Indicates whether the request is processed asynchronously. Depending on the request's platform settings, the following scenarios may be applied:\n* **true**: The request is queued and will be executed when the providing service is available in the order in which the requests are received.\n* **false**: The processing of the request is immediately attempted; it may result in an error if the providing service is unavailable.",
"type" : "boolean"
}
}
},
"type" : "object"
},
"ServiceError" : {
"properties" : {
@@ -587,7 +602,8 @@
"format" : "int32",
"type" : "integer"
}
}
},
"type" : "object"
},
"ShowPages" : {
"properties" : {
@@ -627,7 +643,8 @@
"description" : "Indicates whether the welcome page must be shown. Defaults to **false**.",
"type" : "boolean"
}
}
},
"type" : "object"
}
},
"securitySchemes" : {