{"id":14986639,"url":"https://github.com/adyen/adyen-openapi","last_synced_at":"2025-04-05T12:08:21.420Z","repository":{"id":40680516,"uuid":"111377128","full_name":"Adyen/adyen-openapi","owner":"Adyen","description":"OpenAPI specification for the Adyen APIs","archived":false,"fork":false,"pushed_at":"2025-04-02T09:39:57.000Z","size":29055,"stargazers_count":66,"open_issues_count":12,"forks_count":55,"subscribers_count":17,"default_branch":"main","last_synced_at":"2025-04-02T22:54:51.344Z","etag":null,"topics":["adyen","adyen-api","openapi-specification","openapi-standard","swagger-specification"],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Adyen.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-11-20T07:36:35.000Z","updated_at":"2025-04-02T09:40:01.000Z","dependencies_parsed_at":"2023-12-20T17:28:49.569Z","dependency_job_id":"755fe11c-3785-4568-89da-5b0aab07a468","html_url":"https://github.com/Adyen/adyen-openapi","commit_stats":{"total_commits":684,"total_committers":14,"mean_commits":"48.857142857142854","dds":"0.26169590643274854","last_synced_commit":"d1f265ed37f9971a287fb6d48a84a70eceab609b"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Adyen%2Fadyen-openapi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Adyen%2Fadyen-openapi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Adyen%2Fadyen-openapi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Adyen%2Fadyen-openapi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Adyen","download_url":"https://codeload.github.com/Adyen/adyen-openapi/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247332612,"owners_count":20921853,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["adyen","adyen-api","openapi-specification","openapi-standard","swagger-specification"],"created_at":"2024-09-24T14:13:16.140Z","updated_at":"2025-04-05T12:08:21.391Z","avatar_url":"https://github.com/Adyen.png","language":null,"readme":"# Adyen OpenAPI / Swagger definitions\n\nAdyen 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.\n\nThis repository contains Adyen API definition files, represented in the [OpenAPI Specification](https://www.openapis.org/) standard (formerly known as Swagger Specification).\n\n## Folder structure\n\nAPI definitions in this repository are organized into two sub-folders:\n\n```\n   /json – Definition files in the json format.\n   /yaml – Definition files in the yaml format.\n```\n\nWe support the OpenAPI version 3.1.0.\n\n## Usage\n  \nThere are multiple ways you can use the OpenAPI definition to explore the Adyen API:\n-\tIf you want to see the API definitions in action, visit the [Adyen API Explorer](https://docs.adyen.com/api-explorer/) portal.\n-\tIf you prefer to use the classic Swagger toolset, upload these definitions to the [Swagger Editor](http://editor.swagger.io/) or [SwaggerHub](https://swaggerhub.com/).\n-\tAlso, we recommend you use [Postman](https://www.getpostman.com/postman) to import the API definition and create your personal collection of requests.\n\n## Vendor extensions\n\nAdyen'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/).\n\n### x-groups\n\nThis extension provides a list of all endpoint groups for the selected API.\n\nFor example:\n\n``` yaml\nx-groups:\n  - General\n  - Modifications\n```\n\n### x-groupName and x-sortIndex\n\nThese extensions specify how to group endpoints and sort them within a group.\n\nFor example:\n\n``` yaml\npaths:\n    ...\n    post:\n      ...\n      x-groupName: Modifications\n      x-sortIndex: 5\n   ...\n```\n\n### x-publicVersion\n\nThis is an auxiliary extension that helps us verify that the current API version is publicly available.\n\n### x-addedInVersion, x-deprecatedInVersion and x-deprecatedMessage\n\nThese extensions help us add information when a certain endpoint or field has been added, and later when they are deprecated. \n\nIn addition, the `x-deprecatedMessage` can contain a human-readable message explaining what to use instead of a deprecated API, which provides much better developer experience:\n\n``` yaml\n        recurringDetailReference:\n          deprecated: true\n          x-deprecatedInVersion: 49\n          x-deprecatedMessage: Use `storedPaymentMethodId` instead.\n          description: This is the `recurringDetailReference` returned in the response when you created the token.\n          type: string\n        storedPaymentMethodId:\n          x-addedInVersion: 49\n          description: This is the `recurringDetailReference` returned in the response when you created the token.\n          type: string\n```\n\n### x-oneOf, x-anyOf, x-not and x-allOf\n\nThese extensions are equivalent to those from the [JSON Schema](https://json-schema.org/understanding-json-schema/reference/combining.html) but don't enforce strict validation.\n\nWe use them in some rare cases when we need to avoid validation issues with open-source tooling, while still being able to display this information in our [API Explorer](https://docs.adyen.com/api-explorer/).\n\n## Support\n  \nIf you have a feature request, or spotted a bug or a technical problem, create a GitHub issue. For other questions, contact our [Team](https://www.adyen.help/hc/en-us/requests/new).\n  \n## License \n\nThis repository is open source and available under the MIT license. For more information, see the LICENSE file.\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadyen%2Fadyen-openapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fadyen%2Fadyen-openapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadyen%2Fadyen-openapi/lists"}