Skip to content

Commit

Permalink
spec release
Browse files Browse the repository at this point in the history
  • Loading branch information
Adyen Automation committed Jul 31, 2024
1 parent acaff64 commit f8d7171
Show file tree
Hide file tree
Showing 8 changed files with 482 additions and 10 deletions.
109 changes: 108 additions & 1 deletion json/ManagementNotificationService-v1.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@
"name" : "Terminal management"
}
],
"x-staticResponse" : "response.json",
"webhooks" : {
"merchant.created" : {
"post" : {
Expand Down Expand Up @@ -162,6 +161,46 @@
}
}
},
"terminalBoarding.triggered" : {
"post" : {
"tags" : [
"Terminal management"
],
"summary" : "Result of terminal boarding",
"description" : "The boarding of a payment terminal succeeded or failed.",
"x-addedInVersion" : "1",
"operationId" : "post-terminalBoarding.triggered",
"x-sortIndex" : 2,
"x-methodName" : "resultOfTerminalBoarding",
"security" : [
{
"BasicAuth" : [
]
}
],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TerminalBoardingNotificationRequest"
}
}
}
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TerminalBoardingNotificationResponse"
}
}
},
"description" : "OK - the request has succeeded."
}
}
}
},
"terminalSettings.modified" : {
"post" : {
"tags" : [
Expand Down Expand Up @@ -579,6 +618,74 @@
},
"type" : "object"
},
"TerminalBoardingData" : {
"additionalProperties" : false,
"properties" : {
"companyId" : {
"description" : "The unique identifier of the company account.",
"type" : "string"
},
"merchantId" : {
"description" : "The unique identifier of the merchant account.",
"type" : "string"
},
"storeId" : {
"description" : "The unique identifier of the store.",
"type" : "string"
},
"uniqueTerminalId" : {
"description" : "The unique identifier of the terminal.",
"type" : "string"
}
},
"required" : [
"uniqueTerminalId",
"companyId"
],
"type" : "object"
},
"TerminalBoardingNotificationRequest" : {
"additionalProperties" : false,
"properties" : {
"createdAt" : {
"description" : "Timestamp for when the webhook was created.",
"format" : "date-time",
"type" : "string"
},
"data" : {
"description" : "Contains event details.",
"$ref" : "#/components/schemas/TerminalBoardingData"
},
"environment" : {
"description" : "The environment from which the webhook originated.\n\nPossible values: **test**, **live**.",
"type" : "string"
},
"type" : {
"description" : "Type of notification.",
"enum" : [
"terminalBoarding.triggered"
],
"type" : "string"
}
},
"required" : [
"environment",
"createdAt",
"data",
"type"
],
"type" : "object"
},
"TerminalBoardingNotificationResponse" : {
"additionalProperties" : false,
"properties" : {
"notificationResponse" : {
"description" : "Respond with any **2xx** HTTP status code to [accept the webhook](https://docs.adyen.com/development-resources/webhooks#accept-notifications).",
"type" : "string"
}
},
"type" : "object"
},
"TerminalSettingsData" : {
"additionalProperties" : false,
"properties" : {
Expand Down
109 changes: 108 additions & 1 deletion json/ManagementNotificationService-v3.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@
"name" : "Terminal management"
}
],
"x-staticResponse" : "response.json",
"webhooks" : {
"merchant.created" : {
"post" : {
Expand Down Expand Up @@ -252,6 +251,46 @@
}
}
},
"terminalBoarding.triggered" : {
"post" : {
"tags" : [
"Terminal management"
],
"summary" : "Result of terminal boarding",
"description" : "The boarding of a payment terminal succeeded or failed.",
"x-addedInVersion" : "1",
"operationId" : "post-terminalBoarding.triggered",
"x-sortIndex" : 2,
"x-methodName" : "resultOfTerminalBoarding",
"security" : [
{
"BasicAuth" : [
]
}
],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TerminalBoardingNotificationRequest"
}
}
}
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TerminalBoardingNotificationResponse"
}
}
},
"description" : "OK - the request has succeeded."
}
}
}
},
"terminalSettings.modified" : {
"post" : {
"tags" : [
Expand Down Expand Up @@ -737,6 +776,74 @@
},
"type" : "object"
},
"TerminalBoardingData" : {
"additionalProperties" : false,
"properties" : {
"companyId" : {
"description" : "The unique identifier of the company account.",
"type" : "string"
},
"merchantId" : {
"description" : "The unique identifier of the merchant account.",
"type" : "string"
},
"storeId" : {
"description" : "The unique identifier of the store.",
"type" : "string"
},
"uniqueTerminalId" : {
"description" : "The unique identifier of the terminal.",
"type" : "string"
}
},
"required" : [
"uniqueTerminalId",
"companyId"
],
"type" : "object"
},
"TerminalBoardingNotificationRequest" : {
"additionalProperties" : false,
"properties" : {
"createdAt" : {
"description" : "Timestamp for when the webhook was created.",
"format" : "date-time",
"type" : "string"
},
"data" : {
"description" : "Contains event details.",
"$ref" : "#/components/schemas/TerminalBoardingData"
},
"environment" : {
"description" : "The environment from which the webhook originated.\n\nPossible values: **test**, **live**.",
"type" : "string"
},
"type" : {
"description" : "Type of notification.",
"enum" : [
"terminalBoarding.triggered"
],
"type" : "string"
}
},
"required" : [
"environment",
"createdAt",
"data",
"type"
],
"type" : "object"
},
"TerminalBoardingNotificationResponse" : {
"additionalProperties" : false,
"properties" : {
"notificationResponse" : {
"description" : "Respond with any **2xx** HTTP status code to [accept the webhook](https://docs.adyen.com/development-resources/webhooks#accept-notifications).",
"type" : "string"
}
},
"type" : "object"
},
"TerminalSettingsData" : {
"additionalProperties" : false,
"properties" : {
Expand Down
30 changes: 27 additions & 3 deletions json/ManagementService-v1.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16232,7 +16232,7 @@
"type" : "string"
},
"type" : {
"description" : "The type of webhook that is being created. Possible values are:\n\n- **standard**\n- **account-settings-notification**\n- **banktransfer-notification**\n- **boletobancario-notification**\n- **directdebit-notification**\n- **ach-notification-of-change-notification**\n- **pending-notification**\n- **ideal-notification**\n- **ideal-pending-notification**\n- **report-notification**\n- **rreq-notification**\n\nFind out more about [standard notification webhooks](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes) and [other types of notifications](https://docs.adyen.com/development-resources/webhooks/understand-notifications#other-notifications).",
"description" : "The type of webhook that is being created. Possible values are:\n\n- **standard**\n- **account-settings-notification**\n- **banktransfer-notification**\n- **boletobancario-notification**\n- **directdebit-notification**\n- **ach-notification-of-change-notification**\n- **pending-notification**\n- **ideal-notification**\n- **ideal-pending-notification**\n- **report-notification**\n- **rreq-notification**\n- **terminal-settings**\n- **terminal-boarding**\n\nFind out more about [standard notification webhooks](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes) and [other types of notifications](https://docs.adyen.com/development-resources/webhooks/understand-notifications#other-notifications).",
"type" : "string"
},
"url" : {
Expand Down Expand Up @@ -16469,7 +16469,7 @@
"type" : "string"
},
"type" : {
"description" : "The type of webhook that is being created. Possible values are:\n\n- **standard**\n- **account-settings-notification**\n- **banktransfer-notification**\n- **boletobancario-notification**\n- **directdebit-notification**\n- **ach-notification-of-change-notification**\n- **pending-notification**\n- **ideal-notification**\n- **ideal-pending-notification**\n- **report-notification**\n- **rreq-notification**\n\nFind out more about [standard notification webhooks](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes) and [other types of notifications](https://docs.adyen.com/development-resources/webhooks/understand-notifications#other-notifications).",
"description" : "The type of webhook that is being created. Possible values are:\n\n- **standard**\n- **account-settings-notification**\n- **banktransfer-notification**\n- **boletobancario-notification**\n- **directdebit-notification**\n- **ach-notification-of-change-notification**\n- **pending-notification**\n- **ideal-notification**\n- **ideal-pending-notification**\n- **report-notification**\n- **rreq-notification**\n- **terminal-settings**\n- **terminal-boarding**\n\nFind out more about [standard notification webhooks](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes) and [other types of notifications](https://docs.adyen.com/development-resources/webhooks/understand-notifications#other-notifications).",
"type" : "string"
},
"url" : {
Expand Down Expand Up @@ -17969,6 +17969,10 @@
"description" : "Swish details.",
"$ref" : "#/components/schemas/SwishInfo"
},
"ticket" : {
"description" : "Edenred details.",
"$ref" : "#/components/schemas/TicketInfo"
},
"twint" : {
"description" : "Twint details.",
"$ref" : "#/components/schemas/TwintInfo"
Expand Down Expand Up @@ -18075,9 +18079,12 @@
"multibanco",
"onlineBanking_PL",
"paybybank",
"paynow",
"paynow_pos",
"paypal",
"payshop",
"swish",
"ticket",
"trustly",
"twint",
"twint_pos",
Expand Down Expand Up @@ -18238,6 +18245,10 @@
"description" : "Swish details.",
"$ref" : "#/components/schemas/SwishInfo"
},
"ticket" : {
"description" : "Edenred details.",
"$ref" : "#/components/schemas/TicketInfo"
},
"twint" : {
"description" : "Twint details.",
"$ref" : "#/components/schemas/TwintInfo"
Expand Down Expand Up @@ -18283,9 +18294,12 @@
"multibanco",
"onlineBanking_PL",
"paybybank",
"paynow",
"paynow_pos",
"paypal",
"payshop",
"swish",
"ticket",
"trustly",
"twint",
"twint_pos",
Expand Down Expand Up @@ -19948,6 +19962,16 @@
},
"type" : "object"
},
"TicketInfo" : {
"additionalProperties" : false,
"properties" : {
"requestorId" : {
"description" : "Ticket requestorId",
"type" : "string"
}
},
"type" : "object"
},
"Timeouts" : {
"additionalProperties" : false,
"properties" : {
Expand Down Expand Up @@ -20942,7 +20966,7 @@
"type" : "string"
},
"type" : {
"description" : "The type of webhook. Possible values are:\n\n- **standard**\n- **account-settings-notification**\n- **banktransfer-notification**\n- **boletobancario-notification**\n- **directdebit-notification**\n- **ach-notification-of-change-notification**\n- **pending-notification**\n- **ideal-notification**\n- **ideal-pending-notification**\n- **report-notification**\n- **terminal-api-notification**\n- **terminal-settings**\n\nFind out more about [standard notification webhooks](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes) and [other types of notifications](https://docs.adyen.com/development-resources/webhooks/understand-notifications#other-notifications).",
"description" : "The type of webhook. Possible values are:\n\n- **standard**\n- **account-settings-notification**\n- **banktransfer-notification**\n- **boletobancario-notification**\n- **directdebit-notification**\n- **ach-notification-of-change-notification**\n- **pending-notification**\n- **ideal-notification**\n- **ideal-pending-notification**\n- **report-notification**\n- **terminal-api-notification**\n- **terminal-settings**\n- **terminal-boarding**\n\nFind out more about [standard notification webhooks](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes) and [other types of notifications](https://docs.adyen.com/development-resources/webhooks/understand-notifications#other-notifications).",
"type" : "string"
},
"url" : {
Expand Down
Loading

0 comments on commit f8d7171

Please sign in to comment.