Ctrl+K

Force fail lightning payments that are stuck in the in_flight status.

post/api/v2/admin/lightning/payment/{coin}/{walletId}/{paymentId}/fail

Payments may occasionally fail for reasons that Lightning Services cannot handle. In those cases, LS will take the safe path and keep the payment in the in_flight status. This prevents a user from double paying an invoice that actually went through. However, we need a way to move these payments to FAILED state if we are sure they failed.

Path Parameters

  • paymentIdstringRequired
    Lightning payment hash from preimage
    Min length: >= 1 characters
  • coinstringRequired
    A cryptocurrency symbol or token ticker symbol
    Example: btc
  • walletIdstringRequired
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$

200 Response

success boolean required

400 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id