Skip to main content
DELETE
/
v2
/
api-keys
/
{id}
API Key - Revoke
curl --request DELETE \
  --url https://sandbox.hyperswitch.io/v2/api-keys/{id} \
  --header 'Authorization: <api-key>'
{
  "merchant_id": "y3oqhf46pyzuxjbcn2giaqnb44",
  "key_id": "5hEEqkgJUyuxgSKGArHA4mWSnX",
  "revoked": "true"
}

Authorizations

​
Authorization
string
header
required

Format: admin-api-key=<admin-api-key>

Admin API keys allow you to perform some privileged actions such as creating a merchant account and Connector account. This is only used during development.

Path Parameters

​
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"