Skip to main content
DELETE
/
api_keys
/
{merchant_id}
/
{key_id}
API Key - Revoke
curl --request DELETE \
  --url https://sandbox.hyperswitch.io/api_keys/{merchant_id}/{key_id} \
  --header 'api-key: <api-key>'
import requests

url = "https://sandbox.hyperswitch.io/api_keys/{merchant_id}/{key_id}"

headers = {"api-key": "<api-key>"}

response = requests.delete(url, headers=headers)

print(response.text)
const options = {method: 'DELETE', headers: {'api-key': '<api-key>'}};

fetch('https://sandbox.hyperswitch.io/api_keys/{merchant_id}/{key_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.hyperswitch.io/api_keys/{merchant_id}/{key_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"api-key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://sandbox.hyperswitch.io/api_keys/{merchant_id}/{key_id}"

req, _ := http.NewRequest("DELETE", url, nil)

req.Header.Add("api-key", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.delete("https://sandbox.hyperswitch.io/api_keys/{merchant_id}/{key_id}")
.header("api-key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://sandbox.hyperswitch.io/api_keys/{merchant_id}/{key_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "merchant_id": "y3oqhf46pyzuxjbcn2giaqnb44",
  "key_id": "5hEEqkgJUyuxgSKGArHA4mWSnX",
  "revoked": "true"
}

Authorizations

api-key
string
header
required

Admin API keys allow you to perform some privileged actions such as creating a merchant account and Merchant Connector account.

Path Parameters

merchant_id
string
required

The unique identifier for the merchant account

key_id
string
required

The unique identifier for the API Key

Response

API Key revoked

The response body for revoking an API Key.

merchant_id
string
required

The identifier for the Merchant Account.

Maximum string length: 64
Example:

"y3oqhf46pyzuxjbcn2giaqnb44"

key_id
string
required

The identifier for the API Key.

Maximum string length: 64
Example:

"5hEEqkgJUyuxgSKGArHA4mWSnX"

revoked
boolean
required

Indicates whether the API key was revoked or not.

Example:

"true"