diff --git a/README.md b/README.md index 8298062..511ba36 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,30 @@ -# Adyen OpenAPI / Swagger specifications +# Adyen OpenAPI / Swagger definitions Adyen provides [various APIs](https://docs.adyen.com) to help you accept payments on your website or mobile application, implement subscription billing, make payouts, and much more. -This repository contains Adyen API specifications, represented in the [OpenAPI Specification](https://www.openapis.org/) standard (formerly known as Swagger Specification). +This repository contains Adyen API definition files, represented in the [OpenAPI Specification](https://www.openapis.org/) standard (formerly known as Swagger Specification). ## Folder structure -Specifications in this repository are organized into two subfolders: +API definitions in this repository are organized into two subfolders: ``` -/specs - /json – Spec files in the json format. - /yaml – Spec files in the yaml format. + /json – Definition files in the json format. + /yaml – Definition files in the yaml format. ``` We support the OpenAPI version 3.0.0. ## Usage -There are multiple ways you can use the OpenAPI specification to explore the Adyen API: -- If you want to see the OpenAPI specification in action, visit the [Adyen API Explorer](https://docs.adyen.com/api-explorer/) portal. -- If you prefer to use the classic Swagger toolset, upload these specifications to the [Swagger Editor](http://editor.swagger.io/) or [SwaggerHub](https://swaggerhub.com/). -- Also we recommend you use [Postman](https://www.getpostman.com/postman) to import the OpenAPI specification and create your personal collection of requests. +There are multiple ways you can use the OpenAPI definition to explore the Adyen API: +- If you want to see the API definitions in action, visit the [Adyen API Explorer](https://docs.adyen.com/api-explorer/) portal. +- If you prefer to use the classic Swagger toolset, upload these definitions to the [Swagger Editor](http://editor.swagger.io/) or [SwaggerHub](https://swaggerhub.com/). +- Also we recommend you use [Postman](https://www.getpostman.com/postman) to import the API definition and create your personal collection of requests. ## Vendor extensions -Adyen's specifications contain some custom extensions, as [allowed by the OpenAPI standard](https://swagger.io/docs/specification/openapi-extensions/). These are extensions that provide metadata, such as the grouping and sort order of API objects, when they are displayed in the [Adyen API Explorer](https://docs.adyen.com/api-explorer/). +Adyen's API definitions contain some custom extensions, as [allowed by the OpenAPI standard](https://swagger.io/docs/specification/openapi-extensions/). These are extensions that provide metadata, such as the grouping and sort order of API objects, when they are displayed in the [Adyen API Explorer](https://docs.adyen.com/api-explorer/). ### x-groups diff --git a/specs/json/AccountService-v3.json b/json/AccountService-v3.json similarity index 100% rename from specs/json/AccountService-v3.json rename to json/AccountService-v3.json diff --git a/specs/json/AccountService-v4.json b/json/AccountService-v4.json similarity index 100% rename from specs/json/AccountService-v4.json rename to json/AccountService-v4.json diff --git a/specs/json/AccountService-v5.json b/json/AccountService-v5.json similarity index 100% rename from specs/json/AccountService-v5.json rename to json/AccountService-v5.json diff --git a/specs/json/BinLookupService-v40.json b/json/BinLookupService-v40.json similarity index 100% rename from specs/json/BinLookupService-v40.json rename to json/BinLookupService-v40.json diff --git a/specs/json/BinLookupService-v50.json b/json/BinLookupService-v50.json similarity index 100% rename from specs/json/BinLookupService-v50.json rename to json/BinLookupService-v50.json diff --git a/specs/json/CheckoutService-v32.json b/json/CheckoutService-v32.json similarity index 100% rename from specs/json/CheckoutService-v32.json rename to json/CheckoutService-v32.json diff --git a/specs/json/CheckoutService-v33.json b/json/CheckoutService-v33.json similarity index 100% rename from specs/json/CheckoutService-v33.json rename to json/CheckoutService-v33.json diff --git a/specs/json/CheckoutService-v37.json b/json/CheckoutService-v37.json similarity index 100% rename from specs/json/CheckoutService-v37.json rename to json/CheckoutService-v37.json diff --git a/specs/json/CheckoutService-v40.json b/json/CheckoutService-v40.json similarity index 100% rename from specs/json/CheckoutService-v40.json rename to json/CheckoutService-v40.json diff --git a/specs/json/CheckoutService-v41.json b/json/CheckoutService-v41.json similarity index 100% rename from specs/json/CheckoutService-v41.json rename to json/CheckoutService-v41.json diff --git a/specs/json/CheckoutService-v46.json b/json/CheckoutService-v46.json similarity index 100% rename from specs/json/CheckoutService-v46.json rename to json/CheckoutService-v46.json diff --git a/specs/json/CheckoutService-v49.json b/json/CheckoutService-v49.json similarity index 100% rename from specs/json/CheckoutService-v49.json rename to json/CheckoutService-v49.json diff --git a/specs/json/CheckoutService-v50.json b/json/CheckoutService-v50.json similarity index 100% rename from specs/json/CheckoutService-v50.json rename to json/CheckoutService-v50.json diff --git a/specs/json/CheckoutService-v51.json b/json/CheckoutService-v51.json similarity index 100% rename from specs/json/CheckoutService-v51.json rename to json/CheckoutService-v51.json diff --git a/specs/json/CheckoutUtilityService-v1.json b/json/CheckoutUtilityService-v1.json similarity index 100% rename from specs/json/CheckoutUtilityService-v1.json rename to json/CheckoutUtilityService-v1.json diff --git a/specs/json/FundService-v3.json b/json/FundService-v3.json similarity index 100% rename from specs/json/FundService-v3.json rename to json/FundService-v3.json diff --git a/specs/json/FundService-v5.json b/json/FundService-v5.json similarity index 100% rename from specs/json/FundService-v5.json rename to json/FundService-v5.json diff --git a/specs/json/MarketPayNotificationService-v3.json b/json/MarketPayNotificationService-v3.json similarity index 100% rename from specs/json/MarketPayNotificationService-v3.json rename to json/MarketPayNotificationService-v3.json diff --git a/specs/json/MarketPayNotificationService-v4.json b/json/MarketPayNotificationService-v4.json similarity index 100% rename from specs/json/MarketPayNotificationService-v4.json rename to json/MarketPayNotificationService-v4.json diff --git a/specs/json/MarketPayNotificationService-v5.json b/json/MarketPayNotificationService-v5.json similarity index 100% rename from specs/json/MarketPayNotificationService-v5.json rename to json/MarketPayNotificationService-v5.json diff --git a/specs/json/NotificationConfigurationService-v1.json b/json/NotificationConfigurationService-v1.json similarity index 100% rename from specs/json/NotificationConfigurationService-v1.json rename to json/NotificationConfigurationService-v1.json diff --git a/specs/json/NotificationConfigurationService-v2.json b/json/NotificationConfigurationService-v2.json similarity index 100% rename from specs/json/NotificationConfigurationService-v2.json rename to json/NotificationConfigurationService-v2.json diff --git a/specs/json/NotificationConfigurationService-v3.json b/json/NotificationConfigurationService-v3.json similarity index 100% rename from specs/json/NotificationConfigurationService-v3.json rename to json/NotificationConfigurationService-v3.json diff --git a/specs/json/NotificationConfigurationService-v4.json b/json/NotificationConfigurationService-v4.json similarity index 100% rename from specs/json/NotificationConfigurationService-v4.json rename to json/NotificationConfigurationService-v4.json diff --git a/specs/json/NotificationConfigurationService-v5.json b/json/NotificationConfigurationService-v5.json similarity index 100% rename from specs/json/NotificationConfigurationService-v5.json rename to json/NotificationConfigurationService-v5.json diff --git a/specs/json/PaymentService-v12.json b/json/PaymentService-v12.json similarity index 100% rename from specs/json/PaymentService-v12.json rename to json/PaymentService-v12.json diff --git a/specs/json/PaymentService-v18.json b/json/PaymentService-v18.json similarity index 100% rename from specs/json/PaymentService-v18.json rename to json/PaymentService-v18.json diff --git a/specs/json/PaymentService-v25.json b/json/PaymentService-v25.json similarity index 100% rename from specs/json/PaymentService-v25.json rename to json/PaymentService-v25.json diff --git a/specs/json/PaymentService-v30.json b/json/PaymentService-v30.json similarity index 100% rename from specs/json/PaymentService-v30.json rename to json/PaymentService-v30.json diff --git a/specs/json/PaymentService-v40.json b/json/PaymentService-v40.json similarity index 100% rename from specs/json/PaymentService-v40.json rename to json/PaymentService-v40.json diff --git a/specs/json/PaymentService-v46.json b/json/PaymentService-v46.json similarity index 100% rename from specs/json/PaymentService-v46.json rename to json/PaymentService-v46.json diff --git a/specs/json/PaymentService-v49.json b/json/PaymentService-v49.json similarity index 100% rename from specs/json/PaymentService-v49.json rename to json/PaymentService-v49.json diff --git a/specs/json/PaymentService-v50.json b/json/PaymentService-v50.json similarity index 100% rename from specs/json/PaymentService-v50.json rename to json/PaymentService-v50.json diff --git a/specs/json/PaymentService-v51.json b/json/PaymentService-v51.json similarity index 100% rename from specs/json/PaymentService-v51.json rename to json/PaymentService-v51.json diff --git a/specs/json/PayoutService-v30.json b/json/PayoutService-v30.json similarity index 100% rename from specs/json/PayoutService-v30.json rename to json/PayoutService-v30.json diff --git a/specs/json/PayoutService-v40.json b/json/PayoutService-v40.json similarity index 100% rename from specs/json/PayoutService-v40.json rename to json/PayoutService-v40.json diff --git a/specs/json/PayoutService-v46.json b/json/PayoutService-v46.json similarity index 100% rename from specs/json/PayoutService-v46.json rename to json/PayoutService-v46.json diff --git a/specs/json/PayoutService-v49.json b/json/PayoutService-v49.json similarity index 100% rename from specs/json/PayoutService-v49.json rename to json/PayoutService-v49.json diff --git a/specs/json/PayoutService-v50.json b/json/PayoutService-v50.json similarity index 100% rename from specs/json/PayoutService-v50.json rename to json/PayoutService-v50.json diff --git a/specs/json/PayoutService-v51.json b/json/PayoutService-v51.json similarity index 100% rename from specs/json/PayoutService-v51.json rename to json/PayoutService-v51.json diff --git a/specs/json/RecurringService-v18.json b/json/RecurringService-v18.json similarity index 100% rename from specs/json/RecurringService-v18.json rename to json/RecurringService-v18.json diff --git a/specs/json/RecurringService-v25.json b/json/RecurringService-v25.json similarity index 100% rename from specs/json/RecurringService-v25.json rename to json/RecurringService-v25.json diff --git a/specs/json/RecurringService-v30.json b/json/RecurringService-v30.json similarity index 100% rename from specs/json/RecurringService-v30.json rename to json/RecurringService-v30.json diff --git a/specs/json/RecurringService-v40.json b/json/RecurringService-v40.json similarity index 100% rename from specs/json/RecurringService-v40.json rename to json/RecurringService-v40.json diff --git a/specs/json/RecurringService-v49.json b/json/RecurringService-v49.json similarity index 100% rename from specs/json/RecurringService-v49.json rename to json/RecurringService-v49.json diff --git a/specs/json/TestCardService-v1.json b/json/TestCardService-v1.json similarity index 100% rename from specs/json/TestCardService-v1.json rename to json/TestCardService-v1.json diff --git a/specs/yaml/AccountService-v3.yaml b/yaml/AccountService-v3.yaml similarity index 100% rename from specs/yaml/AccountService-v3.yaml rename to yaml/AccountService-v3.yaml diff --git a/specs/yaml/AccountService-v4.yaml b/yaml/AccountService-v4.yaml similarity index 100% rename from specs/yaml/AccountService-v4.yaml rename to yaml/AccountService-v4.yaml diff --git a/specs/yaml/AccountService-v5.yaml b/yaml/AccountService-v5.yaml similarity index 100% rename from specs/yaml/AccountService-v5.yaml rename to yaml/AccountService-v5.yaml diff --git a/specs/yaml/BinLookupService-v40.yaml b/yaml/BinLookupService-v40.yaml similarity index 100% rename from specs/yaml/BinLookupService-v40.yaml rename to yaml/BinLookupService-v40.yaml diff --git a/specs/yaml/BinLookupService-v50.yaml b/yaml/BinLookupService-v50.yaml similarity index 100% rename from specs/yaml/BinLookupService-v50.yaml rename to yaml/BinLookupService-v50.yaml diff --git a/specs/yaml/CheckoutService-v32.yaml b/yaml/CheckoutService-v32.yaml similarity index 100% rename from specs/yaml/CheckoutService-v32.yaml rename to yaml/CheckoutService-v32.yaml diff --git a/specs/yaml/CheckoutService-v33.yaml b/yaml/CheckoutService-v33.yaml similarity index 100% rename from specs/yaml/CheckoutService-v33.yaml rename to yaml/CheckoutService-v33.yaml diff --git a/specs/yaml/CheckoutService-v37.yaml b/yaml/CheckoutService-v37.yaml similarity index 100% rename from specs/yaml/CheckoutService-v37.yaml rename to yaml/CheckoutService-v37.yaml diff --git a/specs/yaml/CheckoutService-v40.yaml b/yaml/CheckoutService-v40.yaml similarity index 100% rename from specs/yaml/CheckoutService-v40.yaml rename to yaml/CheckoutService-v40.yaml diff --git a/specs/yaml/CheckoutService-v41.yaml b/yaml/CheckoutService-v41.yaml similarity index 100% rename from specs/yaml/CheckoutService-v41.yaml rename to yaml/CheckoutService-v41.yaml diff --git a/specs/yaml/CheckoutService-v46.yaml b/yaml/CheckoutService-v46.yaml similarity index 100% rename from specs/yaml/CheckoutService-v46.yaml rename to yaml/CheckoutService-v46.yaml diff --git a/specs/yaml/CheckoutService-v49.yaml b/yaml/CheckoutService-v49.yaml similarity index 100% rename from specs/yaml/CheckoutService-v49.yaml rename to yaml/CheckoutService-v49.yaml diff --git a/specs/yaml/CheckoutService-v50.yaml b/yaml/CheckoutService-v50.yaml similarity index 100% rename from specs/yaml/CheckoutService-v50.yaml rename to yaml/CheckoutService-v50.yaml diff --git a/specs/yaml/CheckoutService-v51.yaml b/yaml/CheckoutService-v51.yaml similarity index 100% rename from specs/yaml/CheckoutService-v51.yaml rename to yaml/CheckoutService-v51.yaml diff --git a/specs/yaml/CheckoutUtilityService-v1.yaml b/yaml/CheckoutUtilityService-v1.yaml similarity index 100% rename from specs/yaml/CheckoutUtilityService-v1.yaml rename to yaml/CheckoutUtilityService-v1.yaml diff --git a/specs/yaml/FundService-v3.yaml b/yaml/FundService-v3.yaml similarity index 100% rename from specs/yaml/FundService-v3.yaml rename to yaml/FundService-v3.yaml diff --git a/specs/yaml/FundService-v5.yaml b/yaml/FundService-v5.yaml similarity index 100% rename from specs/yaml/FundService-v5.yaml rename to yaml/FundService-v5.yaml diff --git a/specs/yaml/MarketPayNotificationService-v3.yaml b/yaml/MarketPayNotificationService-v3.yaml similarity index 100% rename from specs/yaml/MarketPayNotificationService-v3.yaml rename to yaml/MarketPayNotificationService-v3.yaml diff --git a/specs/yaml/MarketPayNotificationService-v4.yaml b/yaml/MarketPayNotificationService-v4.yaml similarity index 100% rename from specs/yaml/MarketPayNotificationService-v4.yaml rename to yaml/MarketPayNotificationService-v4.yaml diff --git a/specs/yaml/MarketPayNotificationService-v5.yaml b/yaml/MarketPayNotificationService-v5.yaml similarity index 100% rename from specs/yaml/MarketPayNotificationService-v5.yaml rename to yaml/MarketPayNotificationService-v5.yaml diff --git a/specs/yaml/NotificationConfigurationService-v1.yaml b/yaml/NotificationConfigurationService-v1.yaml similarity index 100% rename from specs/yaml/NotificationConfigurationService-v1.yaml rename to yaml/NotificationConfigurationService-v1.yaml diff --git a/specs/yaml/NotificationConfigurationService-v2.yaml b/yaml/NotificationConfigurationService-v2.yaml similarity index 100% rename from specs/yaml/NotificationConfigurationService-v2.yaml rename to yaml/NotificationConfigurationService-v2.yaml diff --git a/specs/yaml/NotificationConfigurationService-v3.yaml b/yaml/NotificationConfigurationService-v3.yaml similarity index 100% rename from specs/yaml/NotificationConfigurationService-v3.yaml rename to yaml/NotificationConfigurationService-v3.yaml diff --git a/specs/yaml/NotificationConfigurationService-v4.yaml b/yaml/NotificationConfigurationService-v4.yaml similarity index 100% rename from specs/yaml/NotificationConfigurationService-v4.yaml rename to yaml/NotificationConfigurationService-v4.yaml diff --git a/specs/yaml/NotificationConfigurationService-v5.yaml b/yaml/NotificationConfigurationService-v5.yaml similarity index 100% rename from specs/yaml/NotificationConfigurationService-v5.yaml rename to yaml/NotificationConfigurationService-v5.yaml diff --git a/specs/yaml/PaymentService-v12.yaml b/yaml/PaymentService-v12.yaml similarity index 100% rename from specs/yaml/PaymentService-v12.yaml rename to yaml/PaymentService-v12.yaml diff --git a/specs/yaml/PaymentService-v18.yaml b/yaml/PaymentService-v18.yaml similarity index 100% rename from specs/yaml/PaymentService-v18.yaml rename to yaml/PaymentService-v18.yaml diff --git a/specs/yaml/PaymentService-v25.yaml b/yaml/PaymentService-v25.yaml similarity index 100% rename from specs/yaml/PaymentService-v25.yaml rename to yaml/PaymentService-v25.yaml diff --git a/specs/yaml/PaymentService-v30.yaml b/yaml/PaymentService-v30.yaml similarity index 100% rename from specs/yaml/PaymentService-v30.yaml rename to yaml/PaymentService-v30.yaml diff --git a/specs/yaml/PaymentService-v40.yaml b/yaml/PaymentService-v40.yaml similarity index 100% rename from specs/yaml/PaymentService-v40.yaml rename to yaml/PaymentService-v40.yaml diff --git a/specs/yaml/PaymentService-v46.yaml b/yaml/PaymentService-v46.yaml similarity index 100% rename from specs/yaml/PaymentService-v46.yaml rename to yaml/PaymentService-v46.yaml diff --git a/specs/yaml/PaymentService-v49.yaml b/yaml/PaymentService-v49.yaml similarity index 100% rename from specs/yaml/PaymentService-v49.yaml rename to yaml/PaymentService-v49.yaml diff --git a/specs/yaml/PaymentService-v50.yaml b/yaml/PaymentService-v50.yaml similarity index 100% rename from specs/yaml/PaymentService-v50.yaml rename to yaml/PaymentService-v50.yaml diff --git a/specs/yaml/PaymentService-v51.yaml b/yaml/PaymentService-v51.yaml similarity index 100% rename from specs/yaml/PaymentService-v51.yaml rename to yaml/PaymentService-v51.yaml diff --git a/specs/yaml/PayoutService-v30.yaml b/yaml/PayoutService-v30.yaml similarity index 100% rename from specs/yaml/PayoutService-v30.yaml rename to yaml/PayoutService-v30.yaml diff --git a/specs/yaml/PayoutService-v40.yaml b/yaml/PayoutService-v40.yaml similarity index 100% rename from specs/yaml/PayoutService-v40.yaml rename to yaml/PayoutService-v40.yaml diff --git a/specs/yaml/PayoutService-v46.yaml b/yaml/PayoutService-v46.yaml similarity index 100% rename from specs/yaml/PayoutService-v46.yaml rename to yaml/PayoutService-v46.yaml diff --git a/specs/yaml/PayoutService-v49.yaml b/yaml/PayoutService-v49.yaml similarity index 100% rename from specs/yaml/PayoutService-v49.yaml rename to yaml/PayoutService-v49.yaml diff --git a/specs/yaml/PayoutService-v50.yaml b/yaml/PayoutService-v50.yaml similarity index 100% rename from specs/yaml/PayoutService-v50.yaml rename to yaml/PayoutService-v50.yaml diff --git a/specs/yaml/PayoutService-v51.yaml b/yaml/PayoutService-v51.yaml similarity index 100% rename from specs/yaml/PayoutService-v51.yaml rename to yaml/PayoutService-v51.yaml diff --git a/specs/yaml/RecurringService-v18.yaml b/yaml/RecurringService-v18.yaml similarity index 100% rename from specs/yaml/RecurringService-v18.yaml rename to yaml/RecurringService-v18.yaml diff --git a/specs/yaml/RecurringService-v25.yaml b/yaml/RecurringService-v25.yaml similarity index 100% rename from specs/yaml/RecurringService-v25.yaml rename to yaml/RecurringService-v25.yaml diff --git a/specs/yaml/RecurringService-v30.yaml b/yaml/RecurringService-v30.yaml similarity index 100% rename from specs/yaml/RecurringService-v30.yaml rename to yaml/RecurringService-v30.yaml diff --git a/specs/yaml/RecurringService-v40.yaml b/yaml/RecurringService-v40.yaml similarity index 100% rename from specs/yaml/RecurringService-v40.yaml rename to yaml/RecurringService-v40.yaml diff --git a/specs/yaml/RecurringService-v49.yaml b/yaml/RecurringService-v49.yaml similarity index 100% rename from specs/yaml/RecurringService-v49.yaml rename to yaml/RecurringService-v49.yaml diff --git a/specs/yaml/TestCardService-v1.yaml b/yaml/TestCardService-v1.yaml similarity index 100% rename from specs/yaml/TestCardService-v1.yaml rename to yaml/TestCardService-v1.yaml