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 definition files, represented in the OpenAPI Specification standard (formerly known as Swagger Specification).
API definitions in this repository are organized into two subfolders:
/json – Definition files in the json format.
/yaml – Definition files in the yaml format.
We support the OpenAPI version 3.0.0.
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 portal.
- If you prefer to use the classic Swagger toolset, upload these definitions to the Swagger Editor or SwaggerHub.
- Also we recommend you use Postman to import the API definition and create your personal collection of requests.
Adyen's API definitions 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.
This extension provides a list of all endpoint groups for the selected API.
For example:
x-groups:
- General
- Modifications
These extensions specify how to group endpoints and sort them within a group.
For example:
paths:
...
post:
...
x-groupName: Modifications
x-sortIndex: 5
...
If you have a feature request, or spotted a bug or a technical problem, create a GitHub issue. For other questions, contact our support team.
This repository is open source and available under the MIT license. For more information, see the LICENSE file.