Skip to main content

DeletePayment

DeletePayment deletes an outgoing payment from DB. Note that it will not attempt to delete an In-Flight payment, since that would be unsafe.

Source: lightning.proto

gRPC

rpc DeletePayment (DeletePaymentRequest) returns (DeletePaymentResponse);

REST

HTTP MethodPath
DELETE /v1/payment

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', loaderOptions);
const lnrpc = grpc.loadPackageDefinition(packageDefinition).lnrpc;
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 lnrpc.Lightning(GRPC_HOST, creds);
let request = {
payment_hash: <bytes>,
failed_htlcs_only: <bool>,
};
client.deletePayment(request, function(err, response) {
console.log(response);
});
// Console output:
// {
// }

Messages

lnrpc.DeletePaymentRequest

Source: lightning.proto

FieldgRPC TypeREST TypeREST Placement
payment_hash
bytesstringquery
failed_htlcs_only
boolbooleanquery

lnrpc.DeletePaymentResponse

Source: lightning.proto

note

This response has no parameters.