Skip to main content

TrackPayments

TrackPayments returns an update stream for every payment that is not in a terminal state. Note that if payments are in-flight while starting a new subscription, the start of the payment stream could produce out-of-order and/or duplicate events. In order to get updates for every in-flight payment attempt make sure to subscribe to this method before initiating any payments.

Source: routerrpc/router.proto

gRPC

info

This is a server-streaming RPC

rpc TrackPayments (TrackPaymentsRequest) returns (stream Payment);

REST

HTTP MethodPath
GET /v2/router/payments

Code Samples

const fs = require('fs');
const grpc = require('@grpc/grpc-js');
const protoLoader = require('@grpc/proto-loader');

const GRPC_HOST = 'localhost:10009'
const MACAROON_PATH = 'LND_DIR/data/chain/bitcoin/regtest/admin.macaroon'
const TLS_PATH = 'LND_DIR/tls.cert'

const loaderOptions = {
keepCase: true,
longs: String,
enums: String,
defaults: true,
oneofs: true,
};
const packageDefinition = protoLoader.loadSync(['lightning.proto', 'routerrpc/router.proto'], loaderOptions);
const routerrpc = grpc.loadPackageDefinition(packageDefinition).routerrpc;
process.env.GRPC_SSL_CIPHER_SUITES = 'HIGH+ECDSA';
const tlsCert = fs.readFileSync(TLS_PATH);
const sslCreds = grpc.credentials.createSsl(tlsCert);
const macaroon = fs.readFileSync(MACAROON_PATH).toString('hex');
const macaroonCreds = grpc.credentials.createFromMetadataGenerator(function(args, callback) {
let metadata = new grpc.Metadata();
metadata.add('macaroon', macaroon);
callback(null, metadata);
});
let creds = grpc.credentials.combineChannelCredentials(sslCreds, macaroonCreds);
let client = new routerrpc.Router(GRPC_HOST, creds);
let request = {
no_inflight_updates: <bool>,
};
let call = client.trackPayments(request);
call.on('data', function(response) {
// A response was received from the server.
console.log(response);
});
call.on('status', function(status) {
// The current status of the stream.
});
call.on('end', function() {
// The server has closed the stream.
});
// Console output:
// {
// "payment_hash": <string>,
// "value": <int64>,
// "creation_date": <int64>,
// "fee": <int64>,
// "payment_preimage": <string>,
// "value_sat": <int64>,
// "value_msat": <int64>,
// "payment_request": <string>,
// "status": <PaymentStatus>,
// "fee_sat": <int64>,
// "fee_msat": <int64>,
// "creation_time_ns": <int64>,
// "htlcs": <HTLCAttempt>,
// "payment_index": <uint64>,
// "failure_reason": <PaymentFailureReason>,
// }

Messages

routerrpc.TrackPaymentsRequest

Source: routerrpc/router.proto

FieldgRPC TypeREST TypeREST Placement
no_inflight_updates
boolbooleanquery

lnrpc.Payment

Source: lightning.proto

FieldgRPC TypeREST Type
payment_hash
stringstring
value
int64string
creation_date
int64string
fee
int64string
payment_preimage
stringstring
value_sat
int64string
value_msat
int64string
payment_request
stringstring
status
PaymentStatusstring
fee_sat
int64string
fee_msat
int64string
creation_time_ns
int64string
htlcs
HTLCAttempt[]array
payment_index
uint64string
failure_reason
PaymentFailureReasonstring

Nested Messages

lnrpc.HTLCAttempt

FieldgRPC TypeREST Type
attempt_id
uint64string
status
HTLCStatusstring
route
Routeobject
attempt_time_ns
int64string
resolve_time_ns
int64string
failure
Failureobject
preimage
bytesstring

lnrpc.Route

FieldgRPC TypeREST Type
total_time_lock
uint32integer
total_fees
int64string
total_amt
int64string
hops
Hop[]array
total_fees_msat
int64string
total_amt_msat
int64string

lnrpc.Hop

FieldgRPC TypeREST Type
chan_id
uint64string
chan_capacity
int64string
amt_to_forward
int64string
fee
int64string
expiry
uint32integer
amt_to_forward_msat
int64string
fee_msat
int64string
pub_key
stringstring
tlv_payload
boolboolean
mpp_record
MPPRecordobject
amp_record
AMPRecordobject
custom_records
CustomRecordsEntry[]object
metadata
bytesstring

lnrpc.MPPRecord

FieldgRPC TypeREST Type
payment_addr
bytesstring
total_amt_msat
int64string

lnrpc.AMPRecord

FieldgRPC TypeREST Type
root_share
bytesstring
set_id
bytesstring
child_index
uint32integer

lnrpc.Hop.CustomRecordsEntry

FieldgRPC TypeREST Type
key
uint64unknown
value
bytesunknown

lnrpc.Failure

FieldgRPC TypeREST Type
code
FailureCodestring
channel_update
ChannelUpdateobject
htlc_msat
uint64string
onion_sha_256
bytesstring
cltv_expiry
uint32integer
flags
uint32integer
failure_source_index
uint32integer
height
uint32integer

lnrpc.ChannelUpdate

FieldgRPC TypeREST Type
signature
bytesstring
chain_hash
bytesstring
chan_id
uint64string
timestamp
uint32integer
message_flags
uint32integer
channel_flags
uint32integer
time_lock_delta
uint32integer
htlc_minimum_msat
uint64string
base_fee
uint32integer
fee_rate
uint32integer
htlc_maximum_msat
uint64string
extra_opaque_data
bytesstring

Enums

lnrpc.Payment.PaymentStatus

NameNumber
UNKNOWN
0
IN_FLIGHT
1
SUCCEEDED
2
FAILED
3

lnrpc.HTLCAttempt.HTLCStatus

NameNumber
IN_FLIGHT
0
SUCCEEDED
1
FAILED
2

lnrpc.Failure.FailureCode

NameNumber
RESERVED
0
INCORRECT_OR_UNKNOWN_PAYMENT_DETAILS
1
INCORRECT_PAYMENT_AMOUNT
2
FINAL_INCORRECT_CLTV_EXPIRY
3
FINAL_INCORRECT_HTLC_AMOUNT
4
FINAL_EXPIRY_TOO_SOON
5
INVALID_REALM
6
EXPIRY_TOO_SOON
7
INVALID_ONION_VERSION
8
INVALID_ONION_HMAC
9
INVALID_ONION_KEY
10
AMOUNT_BELOW_MINIMUM
11
FEE_INSUFFICIENT
12
INCORRECT_CLTV_EXPIRY
13
CHANNEL_DISABLED
14
TEMPORARY_CHANNEL_FAILURE
15
REQUIRED_NODE_FEATURE_MISSING
16
REQUIRED_CHANNEL_FEATURE_MISSING
17
UNKNOWN_NEXT_PEER
18
TEMPORARY_NODE_FAILURE
19
PERMANENT_NODE_FAILURE
20
PERMANENT_CHANNEL_FAILURE
21
EXPIRY_TOO_FAR
22
MPP_TIMEOUT
23
INVALID_ONION_PAYLOAD
24
INTERNAL_FAILURE
997
UNKNOWN_FAILURE
998
UNREADABLE_FAILURE
999

lnrpc.PaymentFailureReason

NameNumber
FAILURE_REASON_NONE
0
FAILURE_REASON_TIMEOUT
1
FAILURE_REASON_NO_ROUTE
2
FAILURE_REASON_ERROR
3
FAILURE_REASON_INCORRECT_PAYMENT_DETAILS
4
FAILURE_REASON_INSUFFICIENT_BALANCE
5