Skip to main content
DELETE
API Key - Revoke

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"