spec release

This commit is contained in:
Adyen Automation
2024-03-04 13:10:16 +01:00
parent ed8525a0ae
commit ac2556f4b0
40 changed files with 3188 additions and 2106 deletions

View File

@@ -10,16 +10,12 @@
"x-publicVersion" : true,
"title" : "Notification Configuration 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 Notification Configuration API provides endpoints for setting up and testing notifications that inform you of events on your platform, for example when a verification check or a payout has been completed.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/marketplaces-and-platforms/classic/notifications).\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 Notification Configuration 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/Notification/v2/createNotificationConfiguration\n```",
"x-timestamp" : "2023-05-30T15:27:19Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
"url" : "https://github.com/Adyen/adyen-openapi"
}
},
"x-groups" : [
"General"
],
"tags" : [
{
"name" : "General"
@@ -34,7 +30,6 @@
"summary" : "Subscribe to notifications",
"description" : "Creates a subscription to notifications informing you of events on your platform. After the subscription is created, the events specified in the configuration will be sent to the URL specified in the configuration. Subscriptions must be configured on a per-event basis (as opposed to, for example, a per-account holder basis), so all event notifications of a marketplace and of a given type will be sent to the same endpoint(s). A marketplace may have multiple endpoints if desired; an event notification may be sent to as many or as few different endpoints as configured.",
"operationId" : "post-createNotificationConfiguration",
"x-groupName" : "General",
"x-sortIndex" : 1,
"x-methodName" : "createNotificationConfiguration",
"security" : [
@@ -138,7 +133,6 @@
"summary" : "Delete a notification subscription configuration",
"description" : "Deletes an existing notification subscription configuration. After the subscription is deleted, no further event notifications will be sent to the URL defined in the subscription.",
"operationId" : "post-deleteNotificationConfigurations",
"x-groupName" : "General",
"x-sortIndex" : 6,
"x-methodName" : "deleteNotificationConfigurations",
"security" : [
@@ -242,7 +236,6 @@
"summary" : "Get a notification subscription configuration",
"description" : "Returns the details of the configuration of a notification subscription.",
"operationId" : "post-getNotificationConfiguration",
"x-groupName" : "General",
"x-sortIndex" : 2,
"x-methodName" : "getNotificationConfiguration",
"security" : [
@@ -346,7 +339,6 @@
"summary" : "Get a list of notification subscription configurations",
"description" : "Returns the details of the configurations of all of the notification subscriptions in the platform of the executing user.",
"operationId" : "post-getNotificationConfigurationList",
"x-groupName" : "General",
"x-sortIndex" : 3,
"x-methodName" : "getNotificationConfigurationList",
"security" : [
@@ -450,7 +442,6 @@
"summary" : "Test a notification configuration",
"description" : "Tests an existing notification subscription configuration. For each event type specified, a test notification will be generated and sent to the URL configured in the subscription specified.",
"operationId" : "post-testNotificationConfiguration",
"x-groupName" : "General",
"x-sortIndex" : 4,
"x-methodName" : "testNotificationConfiguration",
"security" : [
@@ -554,7 +545,6 @@
"summary" : "Update a notification subscription configuration",
"description" : "Updates an existing notification subscription configuration. If you are updating the event types, you must provide all event types, otherwise the previous event type configuration will be overwritten.",
"operationId" : "post-updateNotificationConfiguration",
"x-groupName" : "General",
"x-sortIndex" : 5,
"x-methodName" : "updateNotificationConfiguration",
"security" : [
@@ -1252,7 +1242,7 @@
"value" : {
"pspReference" : "8616480452462678",
"errorMessages" : [
"The required string \"[accepted]\" is not in all the results"
"The server did not respond with HTTP 2XX"
],
"eventTypes" : [
"ACCOUNT_HOLDER_VERIFICATION"