Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help 
LIGHTNING-RENEPAYSTATUS(7)			    LIGHTNING-RENEPAYSTATUS(7)

NAME
       lightning-renepaystatus	--  Command for	quering	the status of previous
       renepay attempts

SYNOPSIS
       renepaystatus [invstring]

DESCRIPTION
       Command added in	v23.08.

       The renepaystatus RPC command queries the payment  plugin  renepay  for
       the status of previous payment attempts.

       This command always succeeds.

       •  invstring  (string, optional): If specified, the command will	return
	  a list of payment attempts whose invoice matches  invstring,	other-
	  wise 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  pay-
	  ment.
       •  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 responsi-
       ble.

SEE ALSO
       lightning-renepay(7), lightning-listpays(7)

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
	   }
	 ]
       }

Core Lightning v25.02				    LIGHTNING-RENEPAYSTATUS(7)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=lightning-renepaystatus&sektion=7&manpath=FreeBSD+Ports+14.3.quarterly>

home | help