Skip to main content
Cancelling a recurring payment returns the entire remaining pool to the sender. Any amount already paid to the recipient is settled — only the unpaid remainder returns.
Cancel requires FLAG_CANCELABLE. If the payment was deployed without this flag, neither sender nor anyone else can cancel it.

​
How to Cancel

1

Open the payment

Navigate to Payments and find the active or paused payment.
2

Click Cancel

Click Cancel Payment. The preview shows the remaining pool amount that will return to the sender.
3

Sign and confirm

Sign with the sender wallet. The covenant UTXO is consumed. The remaining pool is sent to the sender’s address in the same transaction. No NFT output is produced — the payment is terminated.

​
Unlimited Streams

For streams deployed with totalAmount = 0, the remaining pool is the entire current BCH or token balance of the UTXO at cancel time.

​
API

POST /api/payments/:id/cancel
x-user-address: bchtest:q...
Content-Type: application/json

{
  "signerAddress": "bchtest:q..."
}

# Response
{
  "success": true,
  "remainingPool": "24500000",
  "senderReturnAddress": "bchtest:q...",
  "wcTransaction": { "...": "..." }
}

POST /api/payments/:id/confirm-cancel
Content-Type: application/json

{
  "txHash": "hex64"
}