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

82
json/NotificationConfigurationService-v6.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/v6/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"
},
"ErrorFieldType" : {
"properties" : {
@@ -692,7 +700,8 @@
"description" : "The type of error field.",
"$ref" : "#/components/schemas/FieldType"
}
}
},
"type" : "object"
},
"ExchangeMessage" : {
"properties" : {
@@ -702,7 +711,8 @@
"messageDescription" : {
"type" : "string"
}
}
},
"type" : "object"
},
"FieldType" : {
"properties" : {
@@ -741,6 +751,7 @@
"city",
"companyRegistration",
"constitutionalDocument",
"controller",
"country",
"countryCode",
"currency",
@@ -830,6 +841,7 @@
"shareholderCodeAndSignatoryCode",
"shareholderCodeOrSignatoryCode",
"shareholderType",
"shareholderTypes",
"shopperInteraction",
"signatory",
"signatoryCode",
@@ -879,7 +891,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"
},
"GenericResponse" : {
"properties" : {
@@ -899,7 +912,8 @@
"description" : "The result code.",
"type" : "string"
}
}
},
"type" : "object"
},
"GetNotificationConfigurationListResponse" : {
"properties" : {
@@ -927,9 +941,7 @@
"type" : "string"
}
},
"required" : [
"configurations"
]
"type" : "object"
},
"GetNotificationConfigurationRequest" : {
"properties" : {
@@ -941,7 +953,8 @@
},
"required" : [
"notificationId"
]
],
"type" : "object"
},
"GetNotificationConfigurationResponse" : {
"properties" : {
@@ -968,7 +981,8 @@
},
"required" : [
"configurationDetails"
]
],
"type" : "object"
},
"NotificationConfigurationDetails" : {
"properties" : {
@@ -1023,10 +1037,7 @@
"type" : "string"
}
},
"required" : [
"eventConfigs",
"notifyURL"
]
"type" : "object"
},
"NotificationEventConfiguration" : {
"properties" : {
@@ -1049,6 +1060,7 @@
"BENEFICIARY_SETUP",
"COMPENSATE_NEGATIVE_BALANCE",
"DIRECT_DEBIT_INITIATED",
"FUNDS_MIGRATED",
"PAYMENT_FAILURE",
"PENDING_CREDIT",
"REFUND_FUNDS_TRANSFER",
@@ -1072,7 +1084,8 @@
"required" : [
"eventType",
"includeMode"
]
],
"type" : "object"
},
"ServiceError" : {
"properties" : {
@@ -1097,7 +1110,8 @@
"format" : "int32",
"type" : "integer"
}
}
},
"type" : "object"
},
"TestNotificationConfigurationRequest" : {
"properties" : {
@@ -1121,6 +1135,7 @@
"BENEFICIARY_SETUP",
"COMPENSATE_NEGATIVE_BALANCE",
"DIRECT_DEBIT_INITIATED",
"FUNDS_MIGRATED",
"PAYMENT_FAILURE",
"PENDING_CREDIT",
"REFUND_FUNDS_TRANSFER",
@@ -1142,7 +1157,8 @@
},
"required" : [
"notificationId"
]
],
"type" : "object"
},
"TestNotificationConfigurationResponse" : {
"properties" : {
@@ -1173,6 +1189,7 @@
"BENEFICIARY_SETUP",
"COMPENSATE_NEGATIVE_BALANCE",
"DIRECT_DEBIT_INITIATED",
"FUNDS_MIGRATED",
"PAYMENT_FAILURE",
"PENDING_CREDIT",
"REFUND_FUNDS_TRANSFER",
@@ -1223,11 +1240,9 @@
}
},
"required" : [
"notificationId",
"eventTypes",
"okMessages",
"exchangeMessages"
]
"notificationId"
],
"type" : "object"
},
"UpdateNotificationConfigurationRequest" : {
"properties" : {
@@ -1238,7 +1253,8 @@
},
"required" : [
"configurationDetails"
]
],
"type" : "object"
}
},
"securitySchemes" : {
@@ -1268,7 +1284,7 @@
"notifyURL" : "https://www.adyen.com/notification-handler",
"notifyUsername" : "testUserName",
"notifyPassword" : "testPassword",
"sslProtocol" : "SSL"
"sslProtocol" : "TLSv13"
}
}
},
@@ -1287,7 +1303,7 @@
],
"notificationId" : 28468,
"notifyURL" : "https://www.adyen.com/notification-handler",
"sslProtocol" : "SSLInsecureCiphers"
"sslProtocol" : "TLSv13"
}
}
},
@@ -1331,7 +1347,7 @@
],
"notificationId" : 50054,
"notifyURL" : "https://www.adyen.com/notification-handler",
"sslProtocol" : "SSLInsecureCiphers"
"sslProtocol" : "TLSv13"
}
}
},
@@ -1359,7 +1375,7 @@
],
"notificationId" : 27893,
"notifyURL" : "https://www.adyen.com/notification-handler",
"sslProtocol" : "SSLInsecureCiphers"
"sslProtocol" : "TLSv13"
},
{
"active" : true,
@@ -1372,7 +1388,7 @@
],
"notificationId" : 25032,
"notifyURL" : "https://www.adyen.com/notification-handler",
"sslProtocol" : "SSLInsecureCiphers"
"sslProtocol" : "TLSv13"
}
]
}
@@ -1436,7 +1452,7 @@
"notifyPassword" : "testPassword2",
"notifyURL" : "https://www.adyen.com/notification-handler",
"notifyUsername" : "testUserName2",
"sslProtocol" : "TLSv10"
"sslProtocol" : "TLSv13"
}
}
},
@@ -1459,7 +1475,7 @@
],
"notificationId" : 21259,
"notifyURL" : "https://www.adyen.com/notification-handler",
"sslProtocol" : "TLSv10"
"sslProtocol" : "TLSv13"
}
}
}