lightning/doc/lightning-listpayments.7

'\" t
.\"     Title: lightning-listpayments
.\"    Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\"      Date: 01/18/2018
.\"    Manual: \ \&
.\"    Source: \ \&
.\"  Language: English
.\"
.TH "LIGHTNING\-LISTPAYME" "7" "01/18/2018" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * 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 \- Protocol for querying payment status
.SH "SYNOPSIS"
.sp
\fBlistpayments\fR
.SH "DESCRIPTION"
.sp
The \fBlistpayments\fR RPC command gets the status of all \fIpay\fR and \fIsendpay\fR commands\&.
.SH "RETURN VALUE"
.sp
On success, an array of objects is returned\&. Each object contains an \fIid\fR (unique internal value assigned at creation), \fIpayment_hash\fR, \fIdestination\fR, \fImsatoshi\fR and \fItimestamp\fR (UNIX timestamp indicating when it was initiated), and a \fIstatus\fR which is one of \fIpending\fR (in progress), \fIcomplete\fR (successfully paid) or \fIfailed\fR\&.
.SH "AUTHOR"
.sp
Christian Decker <decker\&.christian@gmail\&.com> is mainly responsible\&.
.SH "SEE ALSO"
.sp
lightning\-pay(7), lightning\-sendpay(7), lightning\-listinvoice(7)\&.
.SH "RESOURCES"
.sp
Main web site: https://github\&.com/ElementsProject/lightning