Revoke an access token
Last reviewed: Nov 10, 2026
The Revoke Access Token API lets you request an access token be invalidated for all purposes. If, for example, a user indicates to a client that they no longer want the client to have access to something, the client can request the associated token be revoked.
The code snippets below let an authorized client call a management endpoint to revoke a specified access token.
Before you begin
Section titled “Before you begin”We recommend you create an account on the Interledger test network. 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 an access token
Section titled “Revoke an access token”Prerequisites(opens in a new tab)
Initial configuration
If you’re using JavaScript, only do the first step.
-
Add
"type": "module"topackage.json. -
Add the following to
tsconfig.json{"compilerOptions": {"target": "ES2022","module": "ES2022"}}
// Import dependenciesimport { createAuthenticatedClient } from '@interledger/open-payments'
// Initialize clientconst client = await createAuthenticatedClient({ walletAddressUrl: CLIENT_WALLET_ADDRESS, privateKey: PRIVATE_KEY_PATH, keyId: KEY_ID})
// Revoke tokenawait client.token.revoke({ url: MANAGE_URL, accessToken: ACCESS_TOKEN})Prerequisites(opens in a new tab)
// Import dependenciesuse open_payments::client::AuthenticatedResources;
// Initialize clientlet client = create_authenticated_client()?;
// Revoke access tokenlet access_token = get_env_var("ACCESS_TOKEN")?;let token_manage_url = get_env_var("TOKEN_MANAGE_URL")?;
client .token() .revoke(&token_manage_url, Some(&access_token)) .await?;
// Outputprintln!("Access token revoked successfully");Prerequisites(opens in a new tab)
// Import dependenciesuse OpenPayments\AuthClient;use OpenPayments\Config\Config;
// Initialize client$config = new Config( $WALLET_ADDRESS, $PRIVATE_KEY, $KEY_ID);$opClient = new AuthClient($config);
// Revoke token$tokenResponse = $opClient->token()->revoke( [ 'access_token' => $ACCESS_TOKEN, 'url' => $TOKEN_MANAGE_URL ]);Prerequisites(opens in a new tab)
package main
// Import dependenciesimport ( "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 Token if err := client.Token.Revoke(context.TODO(), op.TokenRevokeParams{ URL: MANAGE_URL, AccessToken: ACCESS_TOKEN, }); err != nil { log.Fatalf("Error revoking access token: %v\n", err) }
fmt.Println("Access token revoked successfully")}Prerequisites(opens in a new tab)
// Import dependenciesimport org.interledger.openpayments.httpclient.OpenPaymentsHttpClient;import org.interledger.openpayments.IOpenPaymentsClient;
// Initialize clientvar client = OpenPaymentsHttpClient.defaultClient("WalletAddress","PrivateKeyPEM","KeyId");
// Retrieve the walletsvar receiverWallet = client.walletAddress().get("https://cloudninebank.example.com/merchant");
// Create grant requestvar grantRequest = client.auth().grant().incomingPayment(receiverWallet);
// Revoke grant request// Auth server will be retrieved from [receiverWallet]client.auth().revokeToken(receiverWallet, grant.getAccess().getToken(), grantRequest);
// Outputlog.info("REVOKED GRANT: {}", grantRequest);Prerequisites(opens in a new tab)
// Import dependenciesusing Microsoft.Extensions.DependencyInjection;using OpenPayments.Sdk.Clients;using OpenPayments.Sdk.Extensions;using OpenPayments.Sdk.HttpSignatureUtils;
// Initialize clientvar 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 tokenawait client.RevokeTokenAsync( new AuthRequestArgs { Url = new Uri(MANAGE_URL), AccessToken = ACCESS_TOKEN });