API Key - Retrieve

Retrieve an API Key.

HTTP Request

GET /v2/api-keys/{id}

Request (cURL)

curl
curl --request GET \
  --url https://sandbox.hyperswitch.io/v2/api-keys/{id} \
  --header 'api-key: <api-key>'

Response — 200 (application/json)

Example response
{
  "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

  • api-key (string, header) — required Admin API keys allow you to perform some privileged actions such as creating a merchant account and Connector account.

Path Parameters

  • id (string) — required The unique identifier for the API Key.

Response Schema (fields)

  • 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 ) — required The time at which the API Key was created. Example: "2022-09-10T10:11:12Z"

  • expiration (enum | string) — required Available options: never

  • description (string | null) — optional 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"

Links

  • Edit docs: https://github.com/juspay/hyperswitch/edit/main/api-reference/v2/api-key/api-key--retrieve.mdx

  • Raise issue: https://github.com/juspay/hyperswitch/issues/new?title=Issue%20on%20docs&body=Path:%20/v2/api-key/api-key--retrieve

Related

  • API Key — Create: https://api-reference.hyperswitch.io/v2/api-key/api-key--create

  • API Key — Update: https://api-reference.hyperswitch.io/v2/api-key/api-key--update

Previousapi-keyNextmerchant-account