Jump to Content
River Lightning
API Reference
v1.0

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

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 

Webhooks

RLS utilizes webhooks to communicate withdrawal and deposit state updates to your system so that you do not need to poll RLS to check for new deposits or detect withdrawal state changes.