Skip to main content
PATCH
/
public
/
api-keys
/
{prefix}
/
revoke
Revoke API key
curl --request PATCH \
  --url https://prod-api.pcxpay.com/v1/public/api-keys/{prefix}/revoke \
  --header 'Authorization: <authorization>' \
  --header 'X-Api-Key: <x-api-key>'
{
  "status": "success",
  "message": "<string>",
  "data": {
    "api_key_id": "<string>",
    "prefix": "pcx_abc123",
    "name": "<string>",
    "org_id": "<string>",
    "user_id": "<string>",
    "status": "active",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Headers

​
Authorization
string
default:NONE
required

Bearer JWT for user-facing flows (Bearer eyJraWQ...), or the literal string NONE when authenticating via API key.

Example:

"Bearer eyJraWQ..."

​
X-Api-Key
string
default:NONE
required

API key for server-to-server flows, or the literal string NONE when authenticating via JWT.

Example:

"pcx_abc123_xxxx"

Path Parameters

​
prefix
string
required

Response

API key revoked

​
status
enum<string>
Available options:
success,
error
Example:

"success"

​
message
string
​
data
object