DELETE
/
security
/
apiKeys
/
delete
cURL
curl -X DELETE "https://api.onekhusa.com/sandbox/v1/security/apiKeys/delete" \
  --header "Authorization: Bearer your-jwt-token" \
  --header "Content-Type: application/json" \
  --header "X-Organisation-Id: FYH0NTVW0DXK" \
  --header "X-Merchant-Account-Number: 35253486" \
  --header "Accept-Language: en" \
  -d '{
    "merchantAccountNumber": 67485577,
    "clientKey": 1,
    "deletedBy": "admin@example.com"
  }'
"API key has been deleted successfully"

Authorizations

ā€‹
Authorization
string
header
required

Bearer authentication header of the form Bearer <Token>, where <Token> is your access token.

Headers

ā€‹
X-Organisation-Id
string
required

The organization identifier

ā€‹
X-Merchant-Account-Number
string
required

The merchant account number

ā€‹
Accept-Language
string
default:en

Preferred language for the response

Body

application/json

Request payload for deactivating a client API key

ā€‹
merchantAccountNumber
integer
required

The merchant account that owns the API key

Example:

67485577

ā€‹
clientKey
string
required

The client API key value to deactivate

Example:

"abcdefghijklmnopqrstuvwxyz1234"

ā€‹
changedBy
string
required

Email or identifier of the operator performing the deactivation

Example:

"admin@example.com"

Response

200 - application/json

Success - API key deleted successfully

The response is of type string.

Example:

"API key has been deleted successfully"