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,8 @@
|
||||
"version" : "2",
|
||||
"x-publicVersion" : true,
|
||||
"title" : "Adyen for Platforms: Notification Configuration API",
|
||||
"description" : "The Notification Configuration API provides endpoints for setting up and testing notifications that inform you of events on your platform, for example when a KYC check or a payout has been completed.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications).\n## Authentication\nTo connect to the Notification Configuration API, you must use basic authentication credentials of your web service user. If you don't have one, contact our [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example:\n\n```\ncurl\n-U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nNote that when 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```",
|
||||
"description" : "The 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/platforms/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-05-03T09:24:14Z",
|
||||
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
|
||||
"contact" : {
|
||||
"name" : "Adyen Developer Experience team",
|
||||
@@ -31,7 +32,7 @@
|
||||
"tags" : [
|
||||
"General"
|
||||
],
|
||||
"summary" : "Subscribe to notifications.",
|
||||
"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",
|
||||
@@ -134,8 +135,8 @@
|
||||
"tags" : [
|
||||
"General"
|
||||
],
|
||||
"summary" : "Delete an existing notification subscription configuration.",
|
||||
"description" : "This endpoint is used to delete an existing notification subscription configuration. After the subscription is deleted, no further event notifications will be sent to the URL that was in the subscription.",
|
||||
"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,
|
||||
@@ -152,6 +153,11 @@
|
||||
"requestBody" : {
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"examples" : {
|
||||
"basic" : {
|
||||
"$ref" : "#/components/examples/post-deleteNotificationConfigurations-basic"
|
||||
}
|
||||
},
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/DeleteNotificationConfigurationRequest"
|
||||
}
|
||||
@@ -162,6 +168,11 @@
|
||||
"200" : {
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"examples" : {
|
||||
"basic" : {
|
||||
"$ref" : "#/components/examples/post-deleteNotificationConfigurations-basic-200"
|
||||
}
|
||||
},
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/GenericResponse"
|
||||
}
|
||||
@@ -227,8 +238,8 @@
|
||||
"tags" : [
|
||||
"General"
|
||||
],
|
||||
"summary" : "Retrieve an existing notification subscription configuration.",
|
||||
"description" : "This endpoint is used to retrieve the details of the configuration of a notification subscription.",
|
||||
"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,
|
||||
@@ -245,6 +256,11 @@
|
||||
"requestBody" : {
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"examples" : {
|
||||
"basic" : {
|
||||
"$ref" : "#/components/examples/post-getNotificationConfiguration-basic"
|
||||
}
|
||||
},
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/GetNotificationConfigurationRequest"
|
||||
}
|
||||
@@ -255,6 +271,11 @@
|
||||
"200" : {
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"examples" : {
|
||||
"basic" : {
|
||||
"$ref" : "#/components/examples/post-getNotificationConfiguration-basic-200"
|
||||
}
|
||||
},
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/GetNotificationConfigurationResponse"
|
||||
}
|
||||
@@ -320,8 +341,8 @@
|
||||
"tags" : [
|
||||
"General"
|
||||
],
|
||||
"summary" : "Retrieve a list of existing notification subscription configurations.",
|
||||
"description" : "This endpoint is used to retrieve the details of the configurations of all of the notification subscriptions in the marketplace of the executing user.",
|
||||
"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,
|
||||
@@ -338,6 +359,11 @@
|
||||
"requestBody" : {
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"examples" : {
|
||||
"basic" : {
|
||||
"$ref" : "#/components/examples/post-getNotificationConfigurationList-basic"
|
||||
}
|
||||
},
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/EmptyRequest"
|
||||
}
|
||||
@@ -348,6 +374,11 @@
|
||||
"200" : {
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"examples" : {
|
||||
"basic" : {
|
||||
"$ref" : "#/components/examples/post-getNotificationConfigurationList-basic-200"
|
||||
}
|
||||
},
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/GetNotificationConfigurationListResponse"
|
||||
}
|
||||
@@ -413,8 +444,8 @@
|
||||
"tags" : [
|
||||
"General"
|
||||
],
|
||||
"summary" : "Test an existing notification configuration.",
|
||||
"description" : "This endpoint is used to test 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.",
|
||||
"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,
|
||||
@@ -431,6 +462,11 @@
|
||||
"requestBody" : {
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"examples" : {
|
||||
"basic" : {
|
||||
"$ref" : "#/components/examples/post-testNotificationConfiguration-basic"
|
||||
}
|
||||
},
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/TestNotificationConfigurationRequest"
|
||||
}
|
||||
@@ -441,6 +477,11 @@
|
||||
"200" : {
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"examples" : {
|
||||
"basic" : {
|
||||
"$ref" : "#/components/examples/post-testNotificationConfiguration-basic-200"
|
||||
}
|
||||
},
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/TestNotificationConfigurationResponse"
|
||||
}
|
||||
@@ -506,8 +547,8 @@
|
||||
"tags" : [
|
||||
"General"
|
||||
],
|
||||
"summary" : "Update an existing notification subscription configuration.",
|
||||
"description" : "This endpoint is used to update an existing notification subscription configuration. If updating the event types, all event types desired must be provided, otherwise the previous event type configuration will be overwritten.",
|
||||
"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,
|
||||
@@ -816,9 +857,11 @@
|
||||
"COMPENSATE_NEGATIVE_BALANCE",
|
||||
"DIRECT_DEBIT_INITIATED",
|
||||
"PAYMENT_FAILURE",
|
||||
"PENDING_CREDIT",
|
||||
"REFUND_FUNDS_TRANSFER",
|
||||
"REPORT_AVAILABLE",
|
||||
"SCHEDULED_REFUNDS",
|
||||
"SCORE_SIGNAL_TRIGGERED",
|
||||
"TRANSFER_FUNDS",
|
||||
"TRANSFER_NOT_PAIDOUT_TRANSFERS"
|
||||
],
|
||||
@@ -885,9 +928,11 @@
|
||||
"COMPENSATE_NEGATIVE_BALANCE",
|
||||
"DIRECT_DEBIT_INITIATED",
|
||||
"PAYMENT_FAILURE",
|
||||
"PENDING_CREDIT",
|
||||
"REFUND_FUNDS_TRANSFER",
|
||||
"REPORT_AVAILABLE",
|
||||
"SCHEDULED_REFUNDS",
|
||||
"SCORE_SIGNAL_TRIGGERED",
|
||||
"TRANSFER_FUNDS",
|
||||
"TRANSFER_NOT_PAIDOUT_TRANSFERS"
|
||||
],
|
||||
@@ -934,9 +979,11 @@
|
||||
"COMPENSATE_NEGATIVE_BALANCE",
|
||||
"DIRECT_DEBIT_INITIATED",
|
||||
"PAYMENT_FAILURE",
|
||||
"PENDING_CREDIT",
|
||||
"REFUND_FUNDS_TRANSFER",
|
||||
"REPORT_AVAILABLE",
|
||||
"SCHEDULED_REFUNDS",
|
||||
"SCORE_SIGNAL_TRIGGERED",
|
||||
"TRANSFER_FUNDS",
|
||||
"TRANSFER_NOT_PAIDOUT_TRANSFERS"
|
||||
],
|
||||
@@ -1054,6 +1101,150 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"post-deleteNotificationConfigurations-basic" : {
|
||||
"summary" : "Delete a notification configuration",
|
||||
"description" : "Deletes an existing notification subscription configuration",
|
||||
"value" : {
|
||||
"notificationIds" : [
|
||||
27891
|
||||
]
|
||||
}
|
||||
},
|
||||
"post-deleteNotificationConfigurations-basic-200" : {
|
||||
"summary" : "Delete a notification configuration",
|
||||
"description" : "Example response of deleting a notification configuration",
|
||||
"value" : {
|
||||
"pspReference" : "8516480472498802",
|
||||
"submittedAsync" : "false"
|
||||
}
|
||||
},
|
||||
"post-getNotificationConfiguration-basic" : {
|
||||
"summary" : "Get a notification configuration",
|
||||
"description" : "Returns the details of the configuration of a notification subscription",
|
||||
"value" : {
|
||||
"notificationId" : 21259
|
||||
}
|
||||
},
|
||||
"post-getNotificationConfiguration-basic-200" : {
|
||||
"summary" : "Get a notification configuration",
|
||||
"description" : "Example response with a notification configuration",
|
||||
"value" : {
|
||||
"pspReference" : "8516480418110057",
|
||||
"submittedAsync" : "false",
|
||||
"configurationDetails" : {
|
||||
"active" : "true",
|
||||
"apiVersion" : 4,
|
||||
"description" : "test123",
|
||||
"eventConfigs" : [
|
||||
{
|
||||
"NotificationEventConfiguration" : {
|
||||
"eventType" : "ACCOUNT_HOLDER_VERIFICATION",
|
||||
"includeMode" : "INCLUDE"
|
||||
}
|
||||
}
|
||||
],
|
||||
"messageFormat" : "SOAP",
|
||||
"notificationId" : 50061,
|
||||
"notifyURL" : "https://www.adyen.com/notification-handler",
|
||||
"sendActionHeader" : "true",
|
||||
"sslProtocol" : "SSLInsecureCiphers"
|
||||
}
|
||||
}
|
||||
},
|
||||
"post-getNotificationConfigurationList-basic" : {
|
||||
"summary" : "Get a list of configurations",
|
||||
"description" : "Returns the details of the configurations of all of the notification subscriptions in the platform of the executing user.",
|
||||
"value" : {
|
||||
|
||||
}
|
||||
},
|
||||
"post-getNotificationConfigurationList-basic-200" : {
|
||||
"summary" : "Get a list of configuration",
|
||||
"description" : "Example response with a list of notification configurations for the executing user",
|
||||
"value" : {
|
||||
"pspReference" : "8516480434183690",
|
||||
"submittedAsync" : "false",
|
||||
"configurations" : [
|
||||
{
|
||||
"NotificationConfigurationDetails" : {
|
||||
"active" : "true",
|
||||
"description" : "Unique description 12223",
|
||||
"eventConfigs" : [
|
||||
{
|
||||
"NotificationEventConfiguration" : {
|
||||
"eventType" : "ACCOUNT_HOLDER_VERIFICATION",
|
||||
"includeMode" : "INCLUDE"
|
||||
}
|
||||
}
|
||||
],
|
||||
"messageFormat" : "JSON",
|
||||
"notificationId" : 27893,
|
||||
"notifyURL" : "https://www.adyen.com/notification-handler",
|
||||
"sendActionHeader" : "false",
|
||||
"sslProtocol" : "SSLInsecureCiphers"
|
||||
}
|
||||
},
|
||||
{
|
||||
"NotificationConfigurationDetails" : {
|
||||
"active" : "true",
|
||||
"description" : "just testing things",
|
||||
"eventConfigs" : [
|
||||
{
|
||||
"NotificationEventConfiguration" : {
|
||||
"eventType" : "ACCOUNT_HOLDER_VERIFICATION",
|
||||
"includeMode" : "INCLUDE"
|
||||
}
|
||||
}
|
||||
],
|
||||
"messageFormat" : "JSON",
|
||||
"notificationId" : 25032,
|
||||
"notifyURL" : "https://www.adyen.com/notification-handler",
|
||||
"sendActionHeader" : "false",
|
||||
"sslProtocol" : "SSLInsecureCiphers"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"post-testNotificationConfiguration-basic" : {
|
||||
"summary" : "Test a notification configuration",
|
||||
"description" : "Returns the test result for a notification subscription",
|
||||
"value" : {
|
||||
"eventTypes" : [
|
||||
"ACCOUNT_HOLDER_VERIFICATION"
|
||||
],
|
||||
"notificationId" : 25032
|
||||
}
|
||||
},
|
||||
"post-testNotificationConfiguration-basic-200" : {
|
||||
"summary" : "Test a notification configuration",
|
||||
"description" : "Example response of a test notification configuration request",
|
||||
"value" : {
|
||||
"pspReference" : "8616480452462678",
|
||||
"errorMessages" : [
|
||||
"The required string \"[accepted]\" is not in all the results"
|
||||
],
|
||||
"eventTypes" : [
|
||||
"ACCOUNT_HOLDER_VERIFICATION"
|
||||
],
|
||||
"exchangeMessages" : [
|
||||
{
|
||||
"messageCode" : "Number",
|
||||
"messageDescription" : "1"
|
||||
},
|
||||
{
|
||||
"messageCode" : "Title",
|
||||
"messageDescription" : "Test 1: 8616480452462678"
|
||||
}
|
||||
],
|
||||
"notificationId" : 25032,
|
||||
"okMessages" : [
|
||||
"...",
|
||||
"ResponseTime_ms: 262",
|
||||
"ResponseCode: 404"
|
||||
]
|
||||
}
|
||||
},
|
||||
"post-updateNotificationConfiguration-basic" : {
|
||||
"summary" : "Update notification configurations",
|
||||
"value" : {
|
||||
|
||||
Reference in New Issue
Block a user