The project is to create an open source standard APIs for which banks can publish their integration APIs.

What is this repository for? ###

• Quick summary

Although Banks generally have APIs (many are not at that level of technology maturity yet), these APIs do not cover the complete gamut of requirements of Fintechs or the need of their customers. The Open Banking API is a way to bring a standard to the market, for which any bank can follow, then it would make life easier for all players in the ecosystem.

• Version

1.0

• Open Banking Nigeria

How do I get set up? ###

• Summary of set up

Get this repository by running the command below on your terminal

$ git clone https://github.com/openbankingnigeria/api.git

The project can be set up easily by implementing the endpoints as fully documented here.

• How to run tests

You can run tests right here. These tests show a sample request and response payload as defined in the specification.

Contribution guidelines ###

Working on your first Pull Request? You can learn how from this free series How to Contribute to an Open Source Project on GitHub

• Writing tests

All new and modified endpoints MUST have an equivalent unit test. The unit test should ensure the defined payload request and verb is obeyed and the corresponding response is a type of the expected response. You can follow the unit test that is already available in the project.

• Code review

Once you complete a task, submit a pull request. Your code would be merge as soon as it's been reviewed.

Who do I talk to? ###

• The Open Banking Nigeria team

send a mail to contribute@openbanking.ng or fill out the contact form at Open Banking Nigeria and we would contact you.