API Key - Revoke

DELETE /v2/api-keys/{id}

Revoke an API Key.

Request

cURL

curl --request DELETE \
  --url https://sandbox.hyperswitch.io/v2/api-keys/{id} \
  --header 'api-key: <api-key>'

Response

Status: 200 application/json Description: API Key revoked

{
  "merchant_id": "y3oqhf46pyzuxjbcn2giaqnb44",
  "key_id": "5hEEqkgJUyuxgSKGArHA4mWSnX",
  "revoked": "true"
}
Response fields

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

Authorizations

  • api-key (string, header, required) Admin API keys allow you to perform some privileged actions such as creating a merchant account and Connector account.

Path parameters

  • id (string, required) The unique identifier for the API Key.

Related

  • Documentation: https://api-reference.hyperswitch.io/introduction

  • Locker API Reference: https://api-reference.hyperswitch.io/locker-api-reference/overview

  • Intelligent Router API Reference: https://api-reference.hyperswitch.io/intelligent-router-api-reference/overview

Suggest edits: https://github.com/juspay/hyperswitch/edit/main/api-reference/v2/api-key/api-key--revoke.mdx Raise issue: https://github.com/juspay/hyperswitch/issues/new?title=Issue%20on%20docs&body=Path:%20/v2/api-key/api-key--revoke

Previous / Next:

  • API Key - Update: https://api-reference.hyperswitch.io/v2/api-key/api-key--update

  • API Key - List: https://api-reference.hyperswitch.io/v2/api-key/api-key--list

PreviousPayments - External 3DS AuthenticationNextRefunds - List