lightning-listpays -- Command for querying payment status

SYNOPSIS

listpays [bolt11] [payment_hash]

The listpay RPC command gets the status of all pay commands, or a single one if either bolt11 or payment_hash was specified.

On success, an array of objects is returned. Each object contains:

bolt11 the bolt11 invoice if provided to pay.

bolt12 if experimental-offers is enabled, and pay was a given a bolt12 invoice, this field will appear instead of bolt11.

payment_hash the payment_hash of the payment.

status one of complete, failed or pending.

payment_preimage if status is complete.

label optional label, if provided to pay or sendonion.

amount_sent_msat total amount sent, in "NNNmsat" format.

For old payments (pre-0.7) we didn’t save the bolt11 string, so in its place are three other fields:

payment_hash the hash of the payment_preimage which will prove payment.

destination the final destination of the payment.

amount_msat the amount the destination received, in "NNNmsat" format.

These three can all be extracted from bolt11, hence are obsolete.

Rusty Russell <rusty@rustcorp.com.au> is mainly responsible.