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

74
json/NotificationConfigurationService-v2.json
View File

@@ -10,7 +10,7 @@
"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" : "2022-10-03T13:24:04Z",
"x-timestamp" : "2023-02-20T18:23:38Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
@@ -37,6 +37,7 @@
"operationId" : "post-createNotificationConfiguration",
"x-groupName" : "General",
"x-sortIndex" : 1,
"x-methodName" : "createNotificationConfiguration",
"security" : [
{
"BasicAuth" : [
@@ -140,6 +141,7 @@
"operationId" : "post-deleteNotificationConfigurations",
"x-groupName" : "General",
"x-sortIndex" : 6,
"x-methodName" : "deleteNotificationConfigurations",
"security" : [
{
"BasicAuth" : [
@@ -243,6 +245,7 @@
"operationId" : "post-getNotificationConfiguration",
"x-groupName" : "General",
"x-sortIndex" : 2,
"x-methodName" : "getNotificationConfiguration",
"security" : [
{
"BasicAuth" : [
@@ -346,6 +349,7 @@
"operationId" : "post-getNotificationConfigurationList",
"x-groupName" : "General",
"x-sortIndex" : 3,
"x-methodName" : "getNotificationConfigurationList",
"security" : [
{
"BasicAuth" : [
@@ -449,6 +453,7 @@
"operationId" : "post-testNotificationConfiguration",
"x-groupName" : "General",
"x-sortIndex" : 4,
"x-methodName" : "testNotificationConfiguration",
"security" : [
{
"BasicAuth" : [
@@ -552,6 +557,7 @@
"operationId" : "post-updateNotificationConfiguration",
"x-groupName" : "General",
"x-sortIndex" : 5,
"x-methodName" : "updateNotificationConfiguration",
"security" : [
{
"BasicAuth" : [
@@ -657,7 +663,8 @@
},
"required" : [
"configurationDetails"
]
],
"type" : "object"
},
"DeleteNotificationConfigurationRequest" : {
"properties" : {
@@ -672,10 +679,11 @@
},
"required" : [
"notificationIds"
]
],
"type" : "object"
},
"EmptyRequest" : {
"type" : "object"
},
"ExchangeMessage" : {
"properties" : {
@@ -685,7 +693,8 @@
"messageDescription" : {
"type" : "string"
}
}
},
"type" : "object"
},
"GenericResponse" : {
"properties" : {
@@ -701,7 +710,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"
},
"GetNotificationConfigurationListResponse" : {
"properties" : {
@@ -725,9 +735,7 @@
"type" : "boolean"
}
},
"required" : [
"configurations"
]
"type" : "object"
},
"GetNotificationConfigurationRequest" : {
"properties" : {
@@ -739,7 +747,8 @@
},
"required" : [
"notificationId"
]
],
"type" : "object"
},
"GetNotificationConfigurationResponse" : {
"properties" : {
@@ -762,7 +771,8 @@
},
"required" : [
"configurationDetails"
]
],
"type" : "object"
},
"NotificationConfigurationDetails" : {
"properties" : {
@@ -826,10 +836,7 @@
"type" : "string"
}
},
"required" : [
"eventConfigs",
"notifyURL"
]
"type" : "object"
},
"NotificationEventConfiguration" : {
"properties" : {
@@ -852,6 +859,7 @@
"BENEFICIARY_SETUP",
"COMPENSATE_NEGATIVE_BALANCE",
"DIRECT_DEBIT_INITIATED",
"FUNDS_MIGRATED",
"PAYMENT_FAILURE",
"PENDING_CREDIT",
"REFUND_FUNDS_TRANSFER",
@@ -875,7 +883,8 @@
"required" : [
"eventType",
"includeMode"
]
],
"type" : "object"
},
"ServiceError" : {
"properties" : {
@@ -900,7 +909,8 @@
"format" : "int32",
"type" : "integer"
}
}
},
"type" : "object"
},
"TestNotificationConfigurationRequest" : {
"properties" : {
@@ -924,6 +934,7 @@
"BENEFICIARY_SETUP",
"COMPENSATE_NEGATIVE_BALANCE",
"DIRECT_DEBIT_INITIATED",
"FUNDS_MIGRATED",
"PAYMENT_FAILURE",
"PENDING_CREDIT",
"REFUND_FUNDS_TRANSFER",
@@ -945,7 +956,8 @@
},
"required" : [
"notificationId"
]
],
"type" : "object"
},
"TestNotificationConfigurationResponse" : {
"properties" : {
@@ -976,6 +988,7 @@
"BENEFICIARY_SETUP",
"COMPENSATE_NEGATIVE_BALANCE",
"DIRECT_DEBIT_INITIATED",
"FUNDS_MIGRATED",
"PAYMENT_FAILURE",
"PENDING_CREDIT",
"REFUND_FUNDS_TRANSFER",
@@ -1022,11 +1035,9 @@
}
},
"required" : [
"notificationId",
"eventTypes",
"okMessages",
"exchangeMessages"
]
"notificationId"
],
"type" : "object"
},
"UpdateNotificationConfigurationRequest" : {
"properties" : {
@@ -1037,7 +1048,8 @@
},
"required" : [
"configurationDetails"
]
],
"type" : "object"
}
},
"securitySchemes" : {
@@ -1071,7 +1083,7 @@
"notifyUsername" : "testUserName",
"notifyPassword" : "testPassword",
"sendActionHeader" : true,
"sslProtocol" : "SSL"
"sslProtocol" : "TLSv13"
}
}
},
@@ -1095,7 +1107,7 @@
"notificationId" : 28467,
"notifyURL" : "https://www.adyen.com/notification-handler",
"sendActionHeader" : "true",
"sslProtocol" : "SSLInsecureCiphers"
"sslProtocol" : "TLSv13"
}
}
},
@@ -1145,7 +1157,7 @@
"notificationId" : 50061,
"notifyURL" : "https://www.adyen.com/notification-handler",
"sendActionHeader" : "true",
"sslProtocol" : "SSLInsecureCiphers"
"sslProtocol" : "TLSv13"
}
}
},
@@ -1179,7 +1191,7 @@
"notificationId" : 27893,
"notifyURL" : "https://www.adyen.com/notification-handler",
"sendActionHeader" : "false",
"sslProtocol" : "SSLInsecureCiphers"
"sslProtocol" : "TLSv13"
}
},
{
@@ -1198,7 +1210,7 @@
"notificationId" : 25032,
"notifyURL" : "https://www.adyen.com/notification-handler",
"sendActionHeader" : "false",
"sslProtocol" : "SSLInsecureCiphers"
"sslProtocol" : "TLSv13"
}
}
]
@@ -1268,7 +1280,7 @@
"notifyURL" : "http://www.adyen.com",
"notifyUsername" : "testUserName2",
"sendActionHeader" : false,
"sslProtocol" : "TLSv10"
"sslProtocol" : "TLSv13"
}
}
},
@@ -1298,7 +1310,7 @@
"notificationId" : 21259,
"notifyURL" : "http://www.adyen.com",
"sendActionHeader" : "false",
"sslProtocol" : "TLSv10"
"sslProtocol" : "TLSv13"
}
}
}