You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
111 lines
2.9 KiB
111 lines
2.9 KiB
'\" t
|
|
.\" Title: lightning-listpayments
|
|
.\" Author: [see the "AUTHOR" section]
|
|
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
|
|
.\" Date: 02/22/2019
|
|
.\" Manual: \ \&
|
|
.\" Source: \ \&
|
|
.\" Language: English
|
|
.\"
|
|
.TH "LIGHTNING\-LISTPAYME" "7" "02/22/2019" "\ \&" "\ \&"
|
|
.\" -----------------------------------------------------------------
|
|
.\" * Define some portability stuff
|
|
.\" -----------------------------------------------------------------
|
|
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
.\" http://bugs.debian.org/507673
|
|
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
|
|
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
.ie \n(.g .ds Aq \(aq
|
|
.el .ds Aq '
|
|
.\" -----------------------------------------------------------------
|
|
.\" * set default formatting
|
|
.\" -----------------------------------------------------------------
|
|
.\" disable hyphenation
|
|
.nh
|
|
.\" disable justification (adjust text to left margin only)
|
|
.ad l
|
|
.\" -----------------------------------------------------------------
|
|
.\" * MAIN CONTENT STARTS HERE *
|
|
.\" -----------------------------------------------------------------
|
|
.SH "NAME"
|
|
lightning-listpayments \- Low\-level command for querying payment status
|
|
.SH "SYNOPSIS"
|
|
.sp
|
|
\fBlistpayments\fR [\fIbolt11\fR] [\fIpayment_hash\fR]
|
|
.SH "DESCRIPTION"
|
|
.sp
|
|
The \fBlistpayments\fR RPC command gets the status of all \fIsendpay\fR commands (which is also used by the \fIpay\fR command), or with \fIbolt11\fR or \fIpayment_hash\fR limits results to that specific payment\&. You cannot specify both\&.
|
|
.sp
|
|
Note that in future there may be more than one concurrent \fIsendpay\fR command per \fIpay\fR, so this command should be used with caution\&.
|
|
.SH "RETURN VALUE"
|
|
.sp
|
|
On success, an array of objects is returned\&. Each object contains:
|
|
.PP
|
|
\fIid\fR
|
|
.RS 4
|
|
unique internal value assigned at creation
|
|
.RE
|
|
.PP
|
|
\fIpayment_hash\fR
|
|
.RS 4
|
|
the hash of the
|
|
\fIpayment_preimage\fR
|
|
which will prove payment\&.
|
|
.RE
|
|
.PP
|
|
\fIdestination\fR
|
|
.RS 4
|
|
the final destination of the payment\&.
|
|
.RE
|
|
.PP
|
|
\fIamount_msat\fR
|
|
.RS 4
|
|
the amount the destination received, in "NNNmsat" format\&.
|
|
.RE
|
|
.PP
|
|
\fIcreated_at\fR
|
|
.RS 4
|
|
the UNIX timestamp showing when this payment was initiated\&.
|
|
.RE
|
|
.PP
|
|
\fIstatus\fR
|
|
.RS 4
|
|
one of
|
|
\fIcomplete\fR,
|
|
\fIfailed\fR
|
|
or
|
|
\fIpending\fR\&.
|
|
.RE
|
|
.PP
|
|
\fIpayment_preimage\fR
|
|
.RS 4
|
|
(if
|
|
\fIstatus\fR
|
|
is
|
|
\fIcomplete\fR) proves payment was received\&.
|
|
.RE
|
|
.PP
|
|
\fIlabel\fR
|
|
.RS 4
|
|
optional
|
|
\fIlabel\fR, if provided to
|
|
\fIsendpay\fR\&.
|
|
.RE
|
|
.PP
|
|
\fIbolt11\fR
|
|
.RS 4
|
|
the
|
|
\fIbolt11\fR
|
|
argument given to
|
|
\fIpay\fR
|
|
(may be missing for pre\-0\&.7 payments)\&.
|
|
.RE
|
|
.SH "AUTHOR"
|
|
.sp
|
|
Christian Decker <decker\&.christian@gmail\&.com> is mainly responsible\&.
|
|
.SH "SEE ALSO"
|
|
.sp
|
|
lightning\-listpays(7), lightning\-sendpay(7), lightning\-listinvoice(7)\&.
|
|
.SH "RESOURCES"
|
|
.sp
|
|
Main web site: https://github\&.com/ElementsProject/lightning
|
|
|