Adyen OpenAPI / Swagger specifications

Adyen provides various APIs 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 standard (formerly known as Swagger Specification).

Folder structure

Specifications in this repository are organized into two subfolders:

/specs
   /2.0 – Spec files in the OpenAPI 2.0 format.
   /3.0 – Spec files in the OpenAPI 3.0.0 format.

We provide specifications in both .json and .yaml formats, with the API version number (e.g. v30) in the file name.

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 portal.
If you prefer to use the classic Swagger toolset, upload these specifications to the Swagger Editor or SwaggerHub.
Also we recommend you use Postman to import the OpenAPI specification and create your personal collection of requests.

Vendor extensions

Adyen's specifications contain some custom extensions, as allowed by the OpenAPI standard. 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.

x-groups

This extension provides a list of all endpoint groups for the selected API.

For example:

x-groups:
  - General
  - Modifications

x-groupName and x-sortIndex

These extensions specify how to group endpoints and sort them within a group.

For example:

paths:
    ...
    post:
      ...
      x-groupName: Modifications
      x-sortIndex: 5
   ...

Support

If you have any questions or suggestions, please feel free to create an issue here or contact Adyen Support.

License

This repository is open source and available under the MIT license. For more information, see the LICENSE file.

mjunaidi / adyen-openapi