aljaz/payments-rest-api
1
0
Fork 0
mirror of https://github.com/aljazceru/payments-rest-api.git synced 2025-12-24 08:54:19 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
2bf95a766037bf45ae01d0a2c19552c6dad8397b
payments-rest-api/README.md
Roy Sheinfeld 2bf95a7660 Update README.md
2025-06-10 15:57:32 +03:00

1.0 KiB
Raw Blame History

Breez Payments REST API

Breez Payments Rest API is a REST API on top of Breez Nodeless SDK build with fastapi. It enables integrations like breez-woocommerce. It is built to be easily deployable anywhere, with support for providers with free tier like fly.io.

API documentation

OpenAPI documentation is generated on every instance at <api-url>/docs. It can also be downloaded here.

API Key Security

X-API-KEY header serves as authorization method for accessing the API. Anyone that knows the API url and API_SECRET can access your funds, so make sure to protect this secret and to generate a unique and long string. You can use generators like this or this.

Deployment options

  • fly.io - deploy fly.io app on their free tier hosting
  • self hosted - deploy anywhere you want with a simple docker deployment