BitGPT 402pay Documentation

Create a new API key

curl --request POST \
  --url https://api.bitgpt.xyz/developers/api_keys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "label": "<string>",
  "description": "<string>",
  "scopes": [],
  "ip_allow_list": [
    "<string>"
  ],
  "expires_at": "<string>"
}
'

import requests

url = "https://api.bitgpt.xyz/developers/api_keys"

payload = {
    "label": "<string>",
    "description": "<string>",
    "scopes": [],
    "ip_allow_list": ["<string>"],
    "expires_at": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    label: '<string>',
    description: '<string>',
    scopes: [],
    ip_allow_list: ['<string>'],
    expires_at: '<string>'
  })
};

fetch('https://api.bitgpt.xyz/developers/api_keys', 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://api.bitgpt.xyz/developers/api_keys",
  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([
    'label' => '<string>',
    'description' => '<string>',
    'scopes' => [
        
    ],
    'ip_allow_list' => [
        '<string>'
    ],
    'expires_at' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://api.bitgpt.xyz/developers/api_keys"

	payload := strings.NewReader("{\n  \"label\": \"<string>\",\n  \"description\": \"<string>\",\n  \"scopes\": [],\n  \"ip_allow_list\": [\n    \"<string>\"\n  ],\n  \"expires_at\": \"<string>\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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://api.bitgpt.xyz/developers/api_keys")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"label\": \"<string>\",\n  \"description\": \"<string>\",\n  \"scopes\": [],\n  \"ip_allow_list\": [\n    \"<string>\"\n  ],\n  \"expires_at\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.bitgpt.xyz/developers/api_keys")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"label\": \"<string>\",\n  \"description\": \"<string>\",\n  \"scopes\": [],\n  \"ip_allow_list\": [\n    \"<string>\"\n  ],\n  \"expires_at\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "status": 200,
  "data": {
    "id": "api_key_0197c0ec-a197-719f-84a9-99270a79b42a",
    "secret": "sk_live_MDE5N2MwZWMtYTE5Ny03NDVlLWE1YmMtYzQyNTQ4M2JiZjAxX2JpdGdwdA",
    "scopes": [
      "products.create"
    ],
    "ip_allow_list": [
      "127.0.0.1"
    ],
    "expires_at": "2026-05-30 20:23:16",
    "created_at": "2025-06-30 15:00:22",
    "updated_at": null
  },
  "error": null,
  "log": null,
  "validator": null,
  "support_id": null,
  "message": "Resource created successfully",
  "env": "development"
}

{
  "error": "<string>",
  "message": null,
  "log": "<string>",
  "validator": {},
  "support_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "data": {}
}

{
  "status": 401,
  "error": "<string>",
  "message": null,
  "log": "<string>",
  "validator": {},
  "support_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "data": {}
}

{
  "status": 403,
  "error": "<string>",
  "message": null,
  "log": "<string>",
  "validator": {},
  "support_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "data": {}
}

POST

developers

api_keys

Create a new API key

curl --request POST \
  --url https://api.bitgpt.xyz/developers/api_keys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "label": "<string>",
  "description": "<string>",
  "scopes": [],
  "ip_allow_list": [
    "<string>"
  ],
  "expires_at": "<string>"
}
'

import requests

url = "https://api.bitgpt.xyz/developers/api_keys"

payload = {
    "label": "<string>",
    "description": "<string>",
    "scopes": [],
    "ip_allow_list": ["<string>"],
    "expires_at": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    label: '<string>',
    description: '<string>',
    scopes: [],
    ip_allow_list: ['<string>'],
    expires_at: '<string>'
  })
};

fetch('https://api.bitgpt.xyz/developers/api_keys', 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://api.bitgpt.xyz/developers/api_keys",
  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([
    'label' => '<string>',
    'description' => '<string>',
    'scopes' => [
        
    ],
    'ip_allow_list' => [
        '<string>'
    ],
    'expires_at' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://api.bitgpt.xyz/developers/api_keys"

	payload := strings.NewReader("{\n  \"label\": \"<string>\",\n  \"description\": \"<string>\",\n  \"scopes\": [],\n  \"ip_allow_list\": [\n    \"<string>\"\n  ],\n  \"expires_at\": \"<string>\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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://api.bitgpt.xyz/developers/api_keys")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"label\": \"<string>\",\n  \"description\": \"<string>\",\n  \"scopes\": [],\n  \"ip_allow_list\": [\n    \"<string>\"\n  ],\n  \"expires_at\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.bitgpt.xyz/developers/api_keys")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"label\": \"<string>\",\n  \"description\": \"<string>\",\n  \"scopes\": [],\n  \"ip_allow_list\": [\n    \"<string>\"\n  ],\n  \"expires_at\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "status": 200,
  "data": {
    "id": "api_key_0197c0ec-a197-719f-84a9-99270a79b42a",
    "secret": "sk_live_MDE5N2MwZWMtYTE5Ny03NDVlLWE1YmMtYzQyNTQ4M2JiZjAxX2JpdGdwdA",
    "scopes": [
      "products.create"
    ],
    "ip_allow_list": [
      "127.0.0.1"
    ],
    "expires_at": "2026-05-30 20:23:16",
    "created_at": "2025-06-30 15:00:22",
    "updated_at": null
  },
  "error": null,
  "log": null,
  "validator": null,
  "support_id": null,
  "message": "Resource created successfully",
  "env": "development"
}

{
  "error": "<string>",
  "message": null,
  "log": "<string>",
  "validator": {},
  "support_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "data": {}
}

{
  "status": 401,
  "error": "<string>",
  "message": null,
  "log": "<string>",
  "validator": {},
  "support_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "data": {}
}

{
  "status": 403,
  "error": "<string>",
  "message": null,
  "log": "<string>",
  "validator": {},
  "support_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "data": {}
}

Authorizations

Authorization

string

header

required

Send your access token as header Authorization: Bearer {accessToken}

Body

application/json

Request body for creating a new API key

label

string

required

Human-readable label for the API key

Maximum string length: 255

description

string

Human-readable description for the API key

scopes

enum<string>[]

List of scopes this API key has access to

Available options:

invoices.create,

invoices.update,

invoices.read,

payments.create,

payments.update,

payments.read,

products.create,

products.read,

products.update,

products.delete,

api_keys.create,

api_keys.update,

api_keys.delete,

api_keys.read,

webhooks.create,

webhooks.read,

webhooks.update,

webhooks.delete,

webhooks_queue.read,

webhooks_queue.update,

notifications.read,

notifications.update,

notifications_settings.read,

notifications_settings.update,

organizations.create,

organizations.read,

organizations.update,

organizations.deactivate,

users.update,

users.deactivate,

users.sessions.read,

users.sessions.deactivate

ip_allow_list

string[]

List of IP addresses allowed to use this API key

expires_at

string<mysql-date-time> | null

Timestamp when the API key expires

Example:

"2025-06-29 16:03:44"

Response

Successful API key creation response

status

enum<integer>

required

Status code of the response

Available options:

200,

201,

202

data

object

required

Response data containing the requested object

Show child attributes

Example:

{
  "id": "api_key_0197c0f1-9589-7990-b421-4b806f637b0c",
  "label": "My API Key",
  "description": "Key for accessing product APIs",
  "secret": "sk_live_MDE5N2MwZjEtOTU4OS03N2U0LWJiY2YtNGQ0OWQ4YTM5NzUzX2JpdGdwdA",
  "scopes": ["products.create"],
  "ip_allow_list": ["127.0.0.1"],
  "expires_at": "2026-05-30 20:23:16",
  "created_at": "2025-06-30 15:05:47",
  "updated_at": null,
  "metrics": {
    "api_key_id": "api_key_0197c0f1-9589-7990-b421-4b806f637b0c",
    "total_requests": 150,
    "last_used_at": "2025-06-30 16:03:44"
  }
}

message

string | null

required

Message of the response, human readable

Example:

"Resource created successfully"

env

enum<string>

required

API environment

Available options:

development,

production

error

string | null

Error message of the response, human readable

Example:

"Invalid email address"

log

Useful informaiton, not always present, to debug the response

Examples:

{ "request_id": "req_1234567890" }

"Some pertinent log message"

validator

object | null

Validator response object, each key is the field name and value is the error message

Example:

{
  "email": "Invalid email address",
  "password": "Password is required"
}

support_id

string<uuid> | null

Support ID linked to the response, used to identify it when talking with our team

Example:

"support_uuidv7-something-else"

⌘I

GET STARTED

WEBHOOKS

API REFERENCE

Create a new API key

Authorizations

Body

Response