API Key5

Authentication3

Blocklist7

Cards3

Contract Routing3

Customers11

Data5

Disputes12

Elimination3

Event3

Gsm4

Key Custodian3

Mandates2

Merchant Account5

Merchant Connector Account5

Organization3

Payment Method Session6

Payment Methods15

Payments16

Payouts9

Platform1

Poll1

Profile5

Proxy1

Refunds4

Relay2

Routing15

Static Routing2

Subscriptions9

Success Rate4

get/healthGet Health

API Key

API Key - Revoke

Revoke the specified API Key. Once revoked, the API Key can no longer be used for authenticating with our APIs.

delete/api_keys/{merchant_id}/{key_id}

Request

The document declares no server URL.
Auth
API key in header api-key
TypeScript
https://skmtc.dev/hyperswitch/apis/dynamic-routing-openapi-3-0/docs/api_keys/:merchant_id/:key_id/delete.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

merchant_idstring required

The unique identifier for the merchant account

key_idstring required

The unique identifier for the API Key

Response

API Key revoked

merchant_idstring required

The identifier for the Merchant Account.

key_idstring required

The identifier for the API Key.

revokedboolean required

Indicates whether the API key was revoked or not.

Example response

{
  "merchant_id": "y3oqhf46pyzuxjbcn2giaqnb44",
  "key_id": "5hEEqkgJUyuxgSKGArHA4mWSnX"
}

Changes

No recorded changes to this operation across all 1 revision of this API.