ApiRefunds
Create a refund for a paid invoice
POST
Lightning has no chargebacks — refunds are merchant-initiated. type=credit records a note (settle off-band); type=payment sends sats back to the customer bolt11/lightning address. Partial refunds supported while total refunded ≤ invoice amount.
bearerinvoiceId*stringX-API-Version?stringAPI version for header-based versioning
Default
"1"Value in
"1""2"application/json- body
type*stringRefund type: "credit" (record only, settle off-band) or "payment" (send sats back)
Default
"payment"Value in
"credit""payment"amountSats?numberAmount in sats to refund. Omit for a full refund of the invoice amount. Partial refunds are allowed.
destination?stringWhere to send the refund: a BOLT11 invoice or lightning address (name@domain.com). Required for type=payment.
reason?stringReason for the refund (shown in history)
curl -X POST 'http://localhost:3001/api/v1/refunds/invoice/string' \ -H 'Content-Type: application/json' \ -d '{ "type": "credit"}'Example Response201
Empty