POST
/
api_keys
/
merchant_id)
curl --request POST \
  --url 'https://sandbox.hyperswitch.io/api_keys/%7Bmerchant_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",
  "api_key": "<string>",
  "created": "2022-09-10T10:11:12Z",
  "expiration": "never"
}

Authorizations

api-key
string
headerrequired

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

Body

application/json
name
string
required

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

description
string | null

A description to provide more context about the API Key.

expiration
required
Available options:
never

Response

200 - application/json
key_id
string
required

The identifier for the API Key.

merchant_id
string
required

The identifier for the Merchant Account.

name
string
required

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

description
string | null

The description to provide more context about the API 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.

created
string
required

The time at which the API Key was created.

expiration
required
Available options:
never
Business Profile - ListAPI Key - Retrieve