Sign in
Payments

Delete payments

Changed on

Deletes all payments matching a filter. Returns the number deleted. Deleting a payment can affect the wallet balance.

delete/v1/payments

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Query parameters

limitinteger nullable

Total amount of results to return

offsetinteger nullable

Offset where to start returning results

idsstring[] nullable

List of IDs

wallet_idstring uuid nullable

Wallet ID. Automatically populated with your ID

status'Pending' | 'Settled' | 'Failed'

Lifecycle status of a payment.

Status

ledger'Lightning' | 'Internal' | 'Onchain'

The ledger a transaction settles on.

Ledger

ln_addressesstring[] nullable

Lightning addresses

btc_addressesstring[] nullable

Bitcoin addresses

order_direction'Asc' | 'Desc'

Direction of result ordering for list endpoints.

Direction of the ordering of results

Response

Success

Changes

  • c3abc288bbc3Revision changes
    • info

      added the new optional query request parameter btc_addresses

    • info

      added the new optional query request parameter ln_addresses