Cancel a grant request

If your client no longer needs access to protected resources, the Cancel Grant API lets you cancel (revoke) the corresponding grant request.

The code snippets below let a client cancel a previously issued grant. When cancelled, the request is placed into a finalized state and no further updates to the grant request are allowed.

Before you begin

We recommend creating a wallet account on the test wallet. 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

Authenticated client required

TypeScript/NodeJS

Prerequisites

Initial configuration

If you’re using JavaScript, only do the first step.

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

2. Add the following to tsconfig.json

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

// Import dependencies
import { createAuthenticatedClient } from '@interledger/open-payments'

// Initialize 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
})

For TypeScript, run tsx path/to/directory/index.ts. View full TS source

For JavaScript, run node path/to/directory/index.js. View full JS source

Rust

Prerequisites

// Import dependencies
use open_payments::client::AuthenticatedResources;
use open_payments::snippets::utils::{create_authenticated_client, get_env_var, load_env};

// Initialize client
let client = create_authenticated_client()?;

// Revoke grant
let access_token = get_env_var("CONTINUE_ACCESS_TOKEN")?;
let continue_uri = get_env_var("CONTINUE_URI")?;

client
    .grant()
    .cancel(&continue_uri, Some(&access_token))
    .await?;

View full source

PHP

Prerequisites

// Import dependencies
use OpenPayments\AuthClient;
use OpenPayments\Config\Config;

// Initialize client
$config = new Config(
    $WALLET_ADDRESS,
    $PRIVATE_KEY,
    $KEY_ID
);
$opClient = new AuthClient($config);

// Revoke grant
$response = $opClient->grant()->cancel(
    [
        'access_token'=> $ACCESS_TOKEN,
        'url' => $CONTINUE_URI
    ]
);

View full source

Go

Prerequisites

package main

// Import dependencies
import (
  "context"
  "fmt"
  "log"

  op "github.com/interledger/open-payments-go"
)

func main() {
  // Initialize client
  client, err := op.NewAuthenticatedClient(WALLET_ADDRESS_URL, PRIVATE_KEY_BASE_64, KEY_ID)
  if err != nil {
    log.Fatalf("Error creating authenticated client: %v\n", err)
  }

  // Revoke grant
  if err := client.Grant.Cancel(context.TODO(), op.GrantCancelParams{
    URL:         CONTINUE_URI,
    AccessToken: CONTINUE_ACCESS_TOKEN,
  }); err != nil {
    log.Fatalf("Error revoking grant: %v\n", err)
  }

  // Output
  fmt.Println("Grant revoked successfully")
}

Java

Prerequisites

// Import dependencies
import org.interledger.openpayments.httpclient.OpenPaymentsHttpClient;
import org.interledger.openpayments.IOpenPaymentsClient;

// Initialize client
var client = OpenPaymentsHttpClient.defaultClient(
"WalletAddress",
"PrivateKeyPEM",
"KeyId"
);

// Retrieve the wallets
var receiverWallet = client.walletAddress().get("https://cloudninebank.example.com/merchant");

// Create incoming payment
var grantRequest = client.auth().grant().incomingPayment(receiverWallet);

// Revoke grant
client.auth().grant().cancel(grantRequest);

// Output
log.info("CANCELLED: {}", grantRequest);

.NET

Prerequisites

// Import dependencies
using Microsoft.Extensions.DependencyInjection;
using OpenPayments.Sdk.Clients;
using OpenPayments.Sdk.Extensions;
using OpenPayments.Sdk.HttpSignatureUtils;

// Initialize client
var client = new ServiceCollection()
    .UseOpenPayments(opts =>
    {
        opts.UseAuthenticatedClient = true;
        opts.KeyId = CLIENT_ID;
        opts.PrivateKey = KeyUtils.LoadPem(CLIENT_SECRET);
        opts.ClientUrl = new Uri(CLIENT_WALLET_ADDRESS);
    })
    .BuildServiceProvider()
    .GetRequiredService<IAuthenticatedClient>();

// Revoke grant
await client.CancelGrantAsync(
    new AuthRequestArgs { Url = new Uri(CONTINUE_URI), AccessToken = CONTINUE_ACCESS_TOKEN }
);

View full source

References

• API specification
• Grant negotiation and authorization