Jump to Content
River Lightning
API ReferenceChangelog
v1.0

API ReferenceRiver Lightning
API Reference
API Reference
v1.0API ReferenceChangelog

System summary

  • River Lightning (API)
  • Authentication
  • API Response
  • Idempotency

River Lightning Services (RLS) API Documentation

  • Account
    • Returns account balance.get
  • Withdrawals
    • Initiates a withdrawal.post
    • Returns a list of withdrawals.get
    • Returns a withdrawal.get
  • Vouchers
    • Create a Voucherpost
    • Returns a list of vouchers.get
    • Returns a voucher by its ID.get
    • Lock a Voucherput
  • Deposit Intents
    • Create a Deposit Intentpost
    • Returns a list of deposit intents.get
    • Returns a deposit intent.get
  • Deposits
    • Returns a list of deposits.get
    • Returns a deposit.get
  • Webhooks
    • Subscribe to a webhook.post
    • Gets a subscribed webhook.get
    • Deletes a webhook.del
  • Utilities
    • Parses a BOLT#11 invoice.put
    • Estimates a fee for a Lightning Network payment.put
    • Estimates a fee for an onchain payment.put
Powered by 

River Lightning (API)

This is the API documentation for the River Lightning Services (RLS) API for easily sending and receiving Bitcoin payments over the Lightning Network (LN) without running any of your own infrastructure. To get started visit the RLS homepage and submit the contact form.

🚧

Please do not enter your production API keys into this webpage