"title":"Command for removing a completed or failed payment",
"description":[
"The **delpay** RPC command deletes a payment with the given `payment_hash` if its status is either `complete` or `failed`. If *partid* and *groupid* are not specified, all payment parts with matchin status are deleted."
],
"request":{
"required":[
"payment_hash",
"status"
],
"properties":{
"payment_hash":{
"type":"hash",
"description":[
"The unique identifier of a payment."
]
},
"status":{
"type":"string",
"description":[
"Expected status of the payment. Only deletes if the payment status matches. Deleting a `pending` payment will return an error."
],
"enum":[
"complete",
"failed"
]
},
"partid":{
"type":"u64",
"description":[
"Specific partid to delete (must be paired with *groupid*)."
]
},
"groupid":{
"type":"u64",
"description":[
"Specific groupid to delete (must be paired with *partid*)."
]
}
},
"pairedWith":[
[
"partid",
"groupid"
]
]
},
"response":{
"required":[
"payments"
],
"properties":{
"payments":{
"type":"array",
"items":{
"type":"object",
"additionalProperties":false,
"required":[
"created_index",
"id",
"payment_hash",
"status",
"amount_sent_msat",
"created_at"
],
"properties":{
"created_index":{
"added":"v23.11",
"type":"u64",
"description":[
"1-based index indicating order this payment was created in."
]
},
"id":{
"type":"u64",
"description":[
"Old synonym for created_index."
]
},
"payment_hash":{
"type":"hash",
"description":[
"The hash of the *payment_preimage* which will prove payment."
]
},
"status":{
"type":"string",
"enum":[
"pending",
"failed",
"complete"
],
"description":[
"Status of the payment."
]
},
"amount_sent_msat":{
"type":"msat",
"description":[
"The amount we actually sent, including fees."
]
},
"partid":{
"type":"u64",
"description":[
"Unique ID within this (multi-part) payment."
]
},
"destination":{
"type":"pubkey",
"description":[
"The final destination of the payment if known."
]
},
"amount_msat":{
"type":"msat",
"description":[
"The amount the destination received, if known."
]
},
"created_at":{
"type":"u64",
"description":[
"The UNIX timestamp showing when this payment was initiated."
]
},
"updated_index":{
"added":"v23.11",
"type":"u64",
"description":[
"1-based index indicating order this payment was changed (only present if it has changed since creation)."
]
},
"completed_at":{
"type":"u64",
"description":[
"The UNIX timestamp showing when this payment was completed."
]
},
"groupid":{
"type":"u64",
"description":[
"Grouping key to disambiguate multiple attempts to pay an invoice or the same payment_hash."
]
},
"payment_preimage":{
"type":"secret",
"description":[
"Proof of payment."
]
},
"label":{
"type":"string",
"description":[
"The label, if given to sendpay."
]
},
"bolt11":{
"type":"string",
"description":[
"The bolt11 string (if pay supplied one)."
]
},
"bolt12":{
"type":"string",
"description":[
"The bolt12 string (if supplied for pay: **experimental-offers** only)."
]
},
"erroronion":{
"type":"hex",
"description":[
"The error onion returned on failure, if any."
]
}
}
}
}
},
"pre_return_value_notes":[
"The returned format is the same as lightning-listsendpays(7). If the payment is a multi-part payment (MPP) the command return a list of payments will be returned -- one payment object for each partid."
