Open Payments: API Documentation

[AlexLakatos]

Summary

The Open Payments APIs are a set of REST APIs a Rafiki instance exposes for clients of an Account Provider to interact with the payment instruments in Rafiki. They are currently partially documented from the Open API specification at docs.openpayments.guide.

Intended Outcomes

The Open Payments APIs are fully documented on docs.openpayments.guide
A public Postman Collection is available and easy to use for all the endpoints documented on docs.openpayments.guide

How will it work?

A user lands at docs.openpayments.guide and is able to follow the instructions there in order to understand the necessary steps for creating an incoming payment and outgoing payment pair on a running Rafiki instance.

Links

• feat: migrate documentation to Starlight open-payments#289
• feat: migrate documentation content open-payments#300