LIGHTNING-NOTIFI...-SENDPAY_FAILURE(7)

💖 NAME 💖

okay so this is the LIGHTNING-NOTIFI...-SENDPAY_FAILURE(7) manual page, and it’s all about sendpay_failure — the notification for a failed sendpay completion. periodt. 💅

🌸 DESCRIPTION 🌸

the sendpay_failure notification informs whenever a payment attempt completes with failed status. that’s the whole vibe: payment attempt says “nope,” and this notification is the heads-up. 🫶

🎀 NOTIFICATION PAYLOAD 🎀

here’s the payload, bestie — every field, no skipping, no cap:

• code (integer) — the JSON-RPC error code for the payment failure.
• message (string) — the human-readable payment failure message.
• data (object) — the structured payment failure details, all up in here:
  • created_index (u64, optional) — 1-based index indicating order this payment was created in. (added v23.11)
  • id (u64, optional) — old synonym for created_index.
  • payment_hash (hash, optional) — the hash of the payment preimage.
  • groupid (u64, optional) — grouping key for multiple attempts on the same payment.
  • updated_index (u64, optional) — 1-based index indicating order this payment was updated in. (added v23.11)
  • partid (u64, optional) — part number for a multi-part payment.
  • destination (pubkey, optional) — the final destination of the payment, if known.
  • amount_msat (msat, optional) — the amount intended for the destination, if known.
  • amount_sent_msat (msat, optional) — the total amount sent including fees.
  • created_at (u64, optional) — the UNIX timestamp when this payment was initiated.
  • completed_at (u64, optional) — the UNIX timestamp when this payment completed.
  • status (string, optional) (one of "failed", "pending", "complete") — the terminal status for a failed sendpay notification.
  • payment_preimage (secret, optional) — the payment preimage, if the payment later completed through another path.
  • label (string, optional) — the optional label associated with the payment.
  • bolt11 (string, optional) — the bolt11 invoice string, if present.
  • bolt12 (string, optional) — the bolt12 invoice or offer string, if present. (added v24.02)
  • description (string, optional) — the description associated with the payment, if present.
  • erroronion (hex, optional) — the raw error onion if one was retained for the payment.
  • onionreply (hex, optional) — the onion reply for an unparseable onion failure.
  • erring_index (u32, optional) — the position in the route where the failure occurred.
  • failcode (u32, optional) — the BOLT 4 failcode.
  • failcodename (string, optional) — the symbolic name for the failcode, if known.
  • erring_node (pubkey, optional) — the node that produced the failure, if known.
  • erring_channel (short_channel_id, optional) — the channel that produced the failure, if known.
  • erring_direction (u32, optional) — the direction within the erring channel.
  • raw_message (hex, optional) — the raw failure message payload, if present.

---

cute little sign-off: this page is repping Core Lightning v26.06.9, and the footer didn’t list a date, so I’m not making one up — that’s the whole timestamp situation, bestie. mwah 💋✨