Skip to main content
GET
/
api_keys
/
{merchant_id}
/
list
API Key - List
curl --request GET \
  --url https://sandbox.hyperswitch.io/api_keys/{merchant_id}/list \
  --header 'api-key: <api-key>'
import requests

url = "https://sandbox.hyperswitch.io/api_keys/{merchant_id}/list"

headers = {"api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'api-key': '<api-key>'}};

fetch('https://sandbox.hyperswitch.io/api_keys/{merchant_id}/list', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.hyperswitch.io/api_keys/{merchant_id}/list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"api-key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://sandbox.hyperswitch.io/api_keys/{merchant_id}/list"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("api-key", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://sandbox.hyperswitch.io/api_keys/{merchant_id}/list")
.header("api-key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://sandbox.hyperswitch.io/api_keys/{merchant_id}/list")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body
[
  {
    "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 Merchant Connector account.

Path Parameters

merchant_id
string
required

The unique identifier for the merchant account

Query Parameters

limit
integer<int64> | null

The maximum number of API Keys to include in the response

skip
integer<int64> | null

The number of API Keys to skip when retrieving the list of API keys.

Response

200 - application/json

List of API Keys retrieved successfully

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"