Guides

Revoke a remit

Close a remit at any moment. What is left returns to your private balance and its agent key can pay nothing more.

Revoking closes a remit. Everything it still holds returns to your private balance in one transaction, and any later payment from its agent key fails. Only the wallet that opened the remit can revoke it, and it needs nobody's agreement.

  1. Open the remit

    In the app, press the remit's row under Your remits.

  2. Press Revoke

    The button is beside the status at the top of the page. The panel Revoke this remit says how much returns to your private balance.

  3. Confirm

    Press Revoke and take back … and approve the transaction. Keep it open cancels. The line moves through Proving, Signing, Sending and Confirmed.

The page now shows the remit as Revoked, and your private balance is up by what the remit held.

What revoking does not touch

Holds that already exist stay as they are. A payment the agent made before the revoke is still waiting for its payee: it settles to the payee if the payee delivers before the deadline, and returns to your private balance if not. Their rows stay in the statement and change status as that happens.

The agent key itself is not destroyed. It can be named in a new remit.

When to revoke

  • The agent's job is done and money is left.
  • The agent key may have been exposed.
  • The terms need to change. Terms are fixed for the life of a remit, so revoke and open another.
  • The remit has expired with a balance in it. An expired remit pays nothing, and what it holds comes back when you revoke it.

What the chain shows

That your wallet revoked a remit. The amount returned is encrypted.

With the SDK

TypeScript
import { createOwner } from '@remit/sdk'

const owner = createOwner({ keys: process.env.OWNER_SECRET_KEY! })
const { signature } = await owner.revoke('<remit id>')
console.log(signature)

After it confirms, a remit.fetch by that remit's agent throws a RemitError, since the key has no live remit left.

Loading the index