Skip to main content
POST
/
api_keys
/
{merchant_id}
API Key - Create
curl --request POST \
  --url https://sandbox.hyperswitch.io/api_keys/{merchant_id} \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '
{
  "name": "Sandbox integration key",
  "expiration": "never",
  "description": "Key used by our developers to integrate with the sandbox environment"
}
'
import requests

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

payload = {
"name": "Sandbox integration key",
"expiration": "never",
"description": "Key used by our developers to integrate with the sandbox environment"
}
headers = {
"api-key": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Sandbox integration key',
expiration: 'never',
description: 'Key used by our developers to integrate with the sandbox environment'
})
};

fetch('https://sandbox.hyperswitch.io/api_keys/{merchant_id}', 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}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Sandbox integration key',
'expiration' => 'never',
'description' => 'Key used by our developers to integrate with the sandbox environment'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)

func main() {

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

payload := strings.NewReader("{\n \"name\": \"Sandbox integration key\",\n \"expiration\": \"never\",\n \"description\": \"Key used by our developers to integrate with the sandbox environment\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://sandbox.hyperswitch.io/api_keys/{merchant_id}")
.header("api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Sandbox integration key\",\n \"expiration\": \"never\",\n \"description\": \"Key used by our developers to integrate with the sandbox environment\"\n}")
.asString();
require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Sandbox integration key\",\n \"expiration\": \"never\",\n \"description\": \"Key used by our developers to integrate with the sandbox environment\"\n}"

response = http.request(request)
puts response.read_body
{
  "key_id": "5hEEqkgJUyuxgSKGArHA4mWSnX",
  "merchant_id": "y3oqhf46pyzuxjbcn2giaqnb44",
  "name": "Sandbox integration key",
  "api_key": "<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

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 string 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 string 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 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"

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

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