POST
/
api_keys
/
{merchant_id}
/
{key_id}
curl --request POST \
  --url https://sandbox.hyperswitch.io/api_keys/{merchant_id}/{key_id} \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '{
  "name": "Sandbox integration key",
  "description": "Key used by our developers to integrate with the sandbox environment",
  "expiration": "never"
}'
{
  "key_id": "5hEEqkgJUyuxgSKGArHA4mWSnX",
  "merchant_id": "y3oqhf46pyzuxjbcn2giaqnb44",
  "name": "Sandbox integration key",
  "description": "Key used by our developers to integrate with the sandbox environment",
  "prefix": "<string>",
  "created": "2022-09-10T10:11:12Z",
  "expiration": "never"
}

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

Body

application/json

The request body for updating an API Key.

Response

200
application/json

API Key updated

The response body for retrieving an API Key.