Crypto Pay API: A Comprehensive Guide

Crypto Pay is a robust payment system integrated with Crypto Bot, enabling seamless cryptocurrency transactions via API. This guide covers its features, recent updates, and implementation.

Recent Changes in Crypto Pay API

Stay updated with the latest enhancements:

Crypto Pay API 1.5.1 (June 16, 2025)
Crypto Pay API 1.5 (September 11, 2024)
Crypto Pay API 1.4 (June 21, 2024)

👉 Explore the full version history

Note: To use the new transfer method, create a new app.

Authorization Guide

Steps to Get Started:

Create an App:
- Open @CryptoBot (or @CryptoTestnetBot for testnet).
- Navigate to Crypto Pay → Create App to generate your API Token.
API Requests:
- Use HTTPS exclusively.
- Pass the token via header: Crypto-Pay-API-Token.
- Endpoint format: https://pay.crypt.bot/api/%method%.

Example Request:

GET https://pay.crypt.bot/api/getMe
Headers: { "Crypto-Pay-API-Token": "YOUR_TOKEN" }

Core Features

1. Receiving Updates

Polling: Use getInvoices to fetch invoices periodically.
Webhooks: Receive real-time updates via HTTPS POST.

2. Key Methods

| Method | Description |
|------------------|----------------------------------------------|
| createInvoice | Generates a new payment invoice. |
| transfer | Sends coins to users (enable in app settings).|
| getBalance | Retrieves app balances. |

👉 View all methods

Webhooks: Real-Time Updates

Setup Webhooks

Go to Crypto Pay → My Apps → Webhooks.
Enter an HTTPS URL for updates.

Security Verification

Validate requests using crypto-pay-api-signature header (HMAC-SHA-256).
Secret key: SHA256 hash of your API token.

Sample Verification Code:

import hmac
import hashlib
signature = hmac.new(secret_key, request_body, hashlib.sha256).hexdigest()

FAQs

Q1: How do I enable the `transfer` method?

A: Navigate to App Settings → Security → Enable Transfers.

Q2: What currencies does Crypto Pay support?

A: Use getCurrencies to fetch the full list (BTC, ETH, USDT, etc.).

Q3: How secure are Webhook updates?

A: Each request includes an HMAC-SHA-256 signature for verification.

Community Libraries

Integrate faster with these developer-tested tools:

Node.js: crypto-pay-api-sdk
Python: pycryptopay
PHP: php-cryptobot-api

👉 Contribute your library