LIGHTNING-RENEPAYSTATUS(7)

πŸ“¦
version 26.06.9 Β· 2 versions
, in nixpkgs unstable

✨ NAME ✨

okay so this is the LIGHTNING-RENEPAYSTATUS(7) page, and renepaystatus is the command that lets you query the status of your previous renepay attempts πŸ’… that's literally it, no cap.


🌸 SYNOPSIS 🌸

renepaystatus [invstring]

πŸ¦‹ DESCRIPTION πŸ¦‹

bestie. listen. 😭

  • Command deprecated in v26.06, removed after v27.03.
  • Command added in v23.08.
WARNING: Deprecated, scheduled for removal in v27.03 πŸ’€ so like… don't get attached, mkay?

The renepaystatus RPC command queries the payment plugin renepay for the status of previous payment attempts πŸ‘‘

This command always succeeds. fr fr, it does not miss. ✨

  • invstring (string, optional) β€” If specified, the command will return a list of payment attempts whose invoice matches invstring, otherwise all payments with be listed. πŸŽ€

πŸ’– RETURN VALUE πŸ’–

On success, an object containing paystatus is returned. It is an array of objects, where each object contains:

  • bolt11 (string) β€” Invoice string BOLT11. 🧾
  • payment_hash (hash) β€” The hash of the payment_preimage which will prove payment. πŸ”
  • created_at (number) β€” The UNIX timestamp showing when this payment was initiated. ⏰
  • groupid (u32) β€” The id for this payment attempt. 🏷️
  • amount_msat (msat) β€” Amount the recipient received. πŸ’Έ
  • status (string) (one of "complete", "pending", "failed") β€” Status of payment. πŸ‘€
  • payment_preimage (secret, optional) β€” The proof of payment: SHA256 of this payment_hash (for completed payments only). πŸ”‘
  • parts (u32, optional) β€” How many attempts this took. 🧩
  • amount_sent_msat (msat, optional) β€” Total amount we sent including fees (for completed payments only). πŸ’°
  • destination (pubkey, optional) β€” The final destination of the payment. πŸ“
  • notes (array of strings, optional) β€” A list of messages for debugging purposes.: πŸ—’οΈ
    • (string, optional) β€” A message generated by renepay. 🫢

πŸ‘‘ AUTHOR πŸ‘‘

Eduardo Quintana-Miranda eduardo.quintana@pm.me is mainly responsible. give him his flowers, he's the main character here 🌟


πŸ’… SEE ALSO πŸ’…

lightning-renepay(7), lightning-listpays(7) β€” go read those too, iykyk πŸ“š


🌈 RESOURCES 🌈

Main web site: https://github.com/ElementsProject/lightning πŸ¦‹


⭐ EXAMPLES ⭐

Example 1:

Request:

$ lightning-cli renepaystatus -k "invstring"="lnbcrt100n1pnt2bolt11invl020100000000bolt11invl020100000000bolt11invl020100000000bolt11invl020100000000bolt11invl020100000000bolt11invl020100000000bolt11invl020100000000bolt11invl020100000000bolt11invl020100000000bolt11invl020100000000"
{
  "id": "example:renepaystatus#1",
  "method": "renepaystatus",
  "params": {
    "invstring": "lnbcrt100n1pnt2bolt11invl020100000000bolt11invl020100000000bolt11invl020100000000bolt11invl020100000000bolt11invl020100000000bolt11invl020100000000bolt11invl020100000000bolt11invl020100000000bolt11invl020100000000bolt11invl020100000000"
  }
}

Response:

{
  "paystatus": [
    {
      "bolt11": "lnbcrt100n1pnt2bolt11invl020100000000bolt11invl020100000000bolt11invl020100000000bolt11invl020100000000bolt11invl020100000000bolt11invl020100000000bolt11invl020100000000bolt11invl020100000000bolt11invl020100000000bolt11invl020100000000",
      "amount_msat": 400000,
      "payment_hash": "paymenthashinvl0210021002100210021002100210021002100210021002100",
      "destination": "nodeid020202020202020202020202020202020202020202020202020202020202",
      "created_at": 1738000000,
      "groupid": 1,
      "parts": 2,
      "status": "complete",
      "payment_preimage": "paymentpreimager010101010101010101010101010101010101010101010101",
      "amount_sent_msat": 400000
    }
  ]
}

that's the whole page babes, go query those payments before it gets yeeted 😭🫢 this was Core Lightning v26.06.9 LIGHTNING-RENEPAYSTATUS(7) β€” stan the deprecation timeline, periodt πŸ’œπŸŽ€

πŸ“¦ where this page comes from