Paystack OpenAPI Specification

The OpenAPI specification for the Paystack API.

Getting Started

The OpenAPI specification provides another alternative to test the Paystack API. You can download the specification and make use of it on:

• SwaggerHub
• OpenAPI (Swagger) Editor

Components

There are three main folders of interest in this repo:

• main: This contains a comprehensive specification of the Paystack API:
  • resources: This contains individual endpoints in each API category
  • responses: This contains the models for responses
  • schemas: This contains models for each endpoint
  • paystack.yml: This is the entry point for all components
• dist: Not all OpenAPI readers can read from different file sources, so we built a single file from all the components in the main directory.
• sdk: This is a single file specification being used for client library generation. It contains just enough parameters for our client libraries.
• use_cases: This is a collection of specifications containing APIs for common use cases of the Paystack API. For example, the wallet.yaml contains the APIs needed to build a wallet feature into your application. The specifications in this directory are used to create the collections in our Postman Workspace.

Contributing

Here are some of the ways to contribute to this repository:

• Create a use case
• Raise an issue
• Suggest an improvement

Issues

Kindly open an issue if you discover any bug or have problems using this library.

License

This repository is made available under the MIT license. Kindly read the LICENSE file for more information.