LIGHTNING-DELPAY(7)

NAME
lightning-delpay - Command for removing a completed or failed payment

SYNOPSIS
delpay payment_hash status

DESCRIPTION
The delpay RPC command deletes a payment with the given payment_hash if its status is either complete or failed. Deleting a pending payment is an error.

    •   payment_hash: The unique identifier of a payment.

    •   status: Expected status of the payment. Only deletes if the payment status matches.

EXAMPLE JSON REQUEST
    {
      "id": 82,
      "method": "delpay",
      "params": {
        "payment_hash": "4fa2f1b001067ec06d7f95b8695b8acd9ef04c1b4d1110e3b94e1fa0687bb1e0",
        "status": "complete"
      }
    }

RETURN VALUE
If successful the command returns a payment object, in the same format as listsendpays. If the payment is a multi-part payment (MPP) the command return a list of payments will be return -- one payment object for each partid. On failure, an error is returned. If the lightning process fails before responding, the caller should use lightning-listsentpays(7) or lightning-listpays(7) to query whether this payment was deleted or not. The following error codes may occur:

    •   -32602: Parameter missed or malformed;

    •   211: Payment status mismatch. Check the correct status via paystatus;

    •   208: Payment with payment_hash not found.

EXAMPLE JSON RESPONSE
    {
       "payments": [
          {
             "id": 2,
             "payment_hash": "8dfd6538eeb33811c9114a75f792a143728d7f05643f38c3d574d3097e8910c0",
             "destination": "0219f8900ee78a89f050c24d8b69492954f9fdbabed753710845eb75d3a75a5880",
             "msatoshi": 1000,
             "amount_msat": "1000msat",
             "msatoshi_sent": 1000,
             "amount_sent_msat": "1000msat",
             "created_at": 1596224858,
             "status": "complete",
             "payment_preimage": "35bd4e2b481a1a84a22215b5372672cf81460a671816960ddb206464359e1822",
             "bolt11": "lntb10n1p0jga20pp53h7k2w8wkvuprjg3ff6l0y4pgdeg6lc9vsln3s74wnfsjl5fzrqqdqdw3jhxazldahx2xqyjw5qcqp2sp5wut5jnhr6n7jd5747ky2g5flmw7hgx9yjnqzu60ps2jf6f7tc0us9qy9qsqu2a0k37nckl62005p69xavlkydkvhnypk4dphffy4x09zltwh9437ad7xkl83tefdarzhu5t30ju5s56wlrg97qkx404pq3srfc425cq3ke9af"
          }
       ]
    }

AUTHOR
Vincenzo Palazzo <vincenzo.palazzo@protonmail.com> is mainly responsible.

SEE ALSO
lightning-listpays(7), lightning-listsendpays(7), lightning-paystatus(7).

RESOURCES
Main web site: https://github.com/ElementsProject/lightning