aljaz/payments-rest-api
1
0
Fork 0
mirror of https://github.com/aljazceru/payments-rest-api.git synced 2026-01-07 15:44:23 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
aa46b070f44e1df67dd1901eeafef4f27b963a92
payments-rest-api/README.md
Aljaz Ceru e980410a6e readme updates
2025-06-13 16:42:27 +02:00

1.1 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 you want.

Deployment options

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

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.