POST
/
v2
/
api-keys
API Key - Create
curl --request POST \
  --url https://sandbox.hyperswitch.io/v2/api-keys \
  --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",
  "api_key": "<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 Connector account.

Body

application/json

The request body for creating an API Key.

​
name
string
required

A unique name for the API Key to help you identify it.

Maximum length: 64
Example:

"Sandbox integration key"

​
expiration
required
Available options:
never
​
description
string | null

A description to provide more context about the API Key.

Maximum length: 256
Example:

"Key used by our developers to integrate with the sandbox environment"

Response

API Key created

The response body for creating an API Key.

​
key_id
string
required

The identifier for the API Key.

Maximum length: 64
Example:

"5hEEqkgJUyuxgSKGArHA4mWSnX"

​
merchant_id
string
required

The identifier for the Merchant Account.

Maximum length: 64
Example:

"y3oqhf46pyzuxjbcn2giaqnb44"

​
name
string
required

The unique name for the API Key to help you identify it.

Maximum length: 64
Example:

"Sandbox integration key"

​
api_key
string
required

The plaintext API Key used for server-side API access. Ensure you store the API Key securely as you will not be able to see it again.

Maximum length: 128
​
created
string<date-time>
required

The time at which the API Key was created.

Example:

"2022-09-10T10:11:12Z"

​
expiration
required
Available options:
never
​
description
string | null

The description to provide more context about the API Key.

Maximum length: 256
Example:

"Key used by our developers to integrate with the sandbox environment"