Skip to main content
GET
/
v2
/
api-keys
/
{id}
API Key - Retrieve
curl --request GET \
  --url https://sandbox.hyperswitch.io/v2/api-keys/{id} \
  --header 'Authorization: <api-key>'
{
  "key_id": "5hEEqkgJUyuxgSKGArHA4mWSnX",
  "merchant_id": "y3oqhf46pyzuxjbcn2giaqnb44",
  "name": "Sandbox integration key",
  "prefix": "<string>",
  "created": "2022-09-10T10:11:12Z",
  "expiration": "never",
  "description": "Key used by our developers to integrate with the sandbox environment"
}

Authorizations

​
Authorization
string
header
required

Format: admin-api-key=<admin-api-key>

Admin API keys allow you to perform some privileged actions such as creating a merchant account and Connector account. This is only used during development.

Path Parameters

​
id
string
required

The unique identifier for the API Key

Response

API Key retrieved

The response body for retrieving an API Key.

​
key_id
string
required

The identifier for the API Key.

Maximum string length: 64
Example:

"5hEEqkgJUyuxgSKGArHA4mWSnX"

​
merchant_id
string
required

The identifier for the Merchant Account.

Maximum string length: 64
Example:

"y3oqhf46pyzuxjbcn2giaqnb44"

​
name
string
required

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

Maximum string length: 64
Example:

"Sandbox integration key"

​
prefix
string
required

The first few characters of the plaintext API Key to help you identify it.

Maximum string length: 64
​
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 string length: 256
Example:

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