Skip to content
This repository has been archived by the owner on Sep 18, 2022. It is now read-only.

Commit

Permalink
Update ListPaymentsRequest message block
Browse files Browse the repository at this point in the history
  • Loading branch information
mayankchhabra authored Feb 28, 2022
1 parent 7c47256 commit 2c1a348
Showing 1 changed file with 22 additions and 2 deletions.
24 changes: 22 additions & 2 deletions resources/rpc.proto
Original file line number Diff line number Diff line change
Expand Up @@ -2359,12 +2359,32 @@ message Payment {
}

message ListPaymentsRequest {
/**
/*
If true, then return payments that have not yet fully completed. This means
that pending payments, as well as failed payments will show up if this
field is set to True.
field is set to true. This flag doesn't change the meaning of the indices,
which are tied to individual payments.
*/
bool include_incomplete = 1;

/*
The index of a payment that will be used as either the start or end of a
query to determine which payments should be returned in the response. The
index_offset is exclusive. In the case of a zero index_offset, the query
will start with the oldest payment when paginating forwards, or will end
with the most recent payment when paginating backwards.
*/
uint64 index_offset = 2;

// The maximal number of payments returned in the response to this query.
uint64 max_payments = 3;

/*
If set, the payments returned will result from seeking backwards from the
specified index offset. This can be used to paginate backwards. The order
of the returned payments is always oldest first (ascending index order).
*/
bool reversed = 4;
}

message ListPaymentsResponse {
Expand Down

0 comments on commit 2c1a348

Please sign in to comment.