core-lightning/doc/lightning-listpays.7.md
Rusty Russell b9ac032329 doc: force refresh of all manpages.
The idea is that you regenerate the man pages in the same commit you
alter them: that's how we know whether to try regenerating them or not
(git doesn't store timestamps, so it can't really tell).

Travis will now check this, so force them all to sync to this commit.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2020-08-25 12:53:13 +09:30

1.4 KiB
Raw Blame History

lightning-listpays -- Command for querying payment status

SYNOPSIS

listpays [bolt11] [payment_hash]

DESCRIPTION

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

RETURN VALUE

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

bolt11 the bolt11 invoice if provided to pay.

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 didnt 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.

AUTHOR

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

SEE ALSO

lightning-pay(7), lightning-paystatus(7), lightning-listsendpays(7).

RESOURCES

Main web site: https://github.com/ElementsProject/lightning