Skip to content

Revoke a grant request

If an authorized client no longer needs access to protected resources, the client can revoke the corresponding grant request.

These code snippets enable a client to revoke (cancel) a grant that it was previously issued. When a grant request is revoked, the request is placed into a finalized state and no further updates to the grant are allowed.

Before you begin

We recommend creating a wallet account on Rafiki.Money, a test wallet provider that’s part of the Interledger testnet. Creating an account allows you to test your client against the Open Payments APIs by using an ILP-enabled wallet funded with play money.

Revoke a grant request

TypeScript
JavaScript

Node 18
A package manager such as NPM or PNPM
Open Payments SDK
TSX

Additional configuration

Add "type": "module" to package.json

Add the following to tsconfig.json

{
  "compilerOptions": {
    "target": "ES2022",
    "module": "ES2022"
  }
}

Get started

Import dependencies

import { createAuthenticatedClient } from "@interledger/open-payments";

Initialize Open Payments client

const client = await createAuthenticatedClient({
  walletAddressUrl: WALLET_ADDRESS,
  privateKey: PRIVATE_KEY_PATH,
  keyId: KEY_ID,
});

Revoke grant

await client.grant.cancel({
  accessToken: CONTINUE_ACCESS_TOKEN,
  url: CONTINUE_URI,
});

Run tsx path/to/directory/index.ts.

View full source

Node 18 or higher
A package manager such as NPM or PNPM
Open Payments SDK

Additional configuration

Add "type": "module" to package.json

Get started

Import dependencies

import { createAuthenticatedClient } from "@interledger/open-payments";

Initialize Open Payments client

const client = await createAuthenticatedClient({
  walletAddressUrl: WALLET_ADDRESS,
  privateKey: PRIVATE_KEY_PATH,
  keyId: KEY_ID,
});

Revoke grant

await client.grant.cancel({
  accessToken: CONTINUE_ACCESS_TOKEN,
  url: CONTINUE_URI,
});

Run node path/to/directory/index.js.

View full source

References