CloudPaya Documentation

Everything you need to accept cryptocurrency payments. Integrate CloudPaya into your website, app, or platform with our REST API, embeddable widget, or one of 8 ready-made plugins.

Quick Start #

Follow these three steps to accept your first crypto payment:

Authentication #

All API requests require your API Key. Include it as a POST parameter or query parameter:

curl -X POST https://cloudpaya.com/api.php \
  -d "api-key=YOUR_API_KEY" \
  -d "function=get-transactions"

Integration Methods #

https://cloudpaya.com/pay.php?checkout_id=custom&price=50&currency=USD&external_reference=ORDER_123&title=Your+Product&redirect=https://yoursite.com/success&cloud=YOUR_API_KEY

curl -X POST https://cloudpaya.com/api.php \
  -d "api-key=YOUR_API_KEY" \
  -d "function=create-transaction" \
  -d "amount=50" \
  -d "cryptocurrency_code=usdt_tron" \
  -d "currency_code=USD" \
  -d "external_reference=ORDER_123"

curl -X POST https://cloudpaya.com/api.php \
  -d "api-key=YOUR_API_KEY" \
  -d "function=payment-link" \
  -d "transaction_id=456"

# Response: https://cloudpaya.com/id/ENCRYPTED_ID?cloud=YOUR_API_KEY

Supported Currencies #

Cryptocurrencies

Fiat Payment Methods

Custom Tokens

Add any ERC-20, BEP-20, or TRC-20 token in Settings → Custom Tokens:

Exchange Rates & Exact Amounts #

Why Stablecoin Amounts Differ Slightly

When requesting $80 in USDT, you might see 79.96 USDT — stablecoins fluctuate slightly. CloudPaya uses real-time rates:

How to Get Exact Amounts

Method 1: Set currency to the stablecoin

curl -X POST https://cloudpaya.com/api.php \
  -d "api-key=YOUR_API_KEY" \
  -d "function=create-transaction" \
  -d "amount=80" \
  -d "currency_code=USDT" \
  -d "cryptocurrency_code=usdt_bsc"
# Result: exactly 80.00 USDT

Method 2: Use currency=crypto

-d "currency_code=crypto"   # skips conversion entirely

Unique Amount System

With a single wallet address, CloudPaya creates micro-unique amounts to identify transactions. To avoid this, add 3+ addresses (comma-separated) to enable address rotation:

# In Settings → USDT BSC Address:
0x706914810dC2445870736AA3BbC2AB2C649a3072,
0x31648324f0Ac44124EBd418b5B3386563b442C38,
0xDC1F5f39c3645c7954f7a752c57aE2688638694E

Dashboard Overview #

Your CloudPaya dashboard is the control center for payments, wallets, and settings.

Setup Guide #

Follow these steps to start accepting crypto payments:

Settings Reference #

General Settings

Cryptocurrency Settings

Fiat Gateways (Optional)

Credits & Pricing #

CloudPaya charges a per-transaction fee deducted from your pre-purchased credit balance. Credits never expire.

Go-Live Checklist

• Created account and logged in
• Added wallet addresses for all desired cryptocurrencies
• Copied API key to your backend
• Set webhook URL and secret
• Implemented webhook handler with signature verification
• Added credits to your account
• Tested end-to-end with a small transaction
• Configured redirect URL for post-payment flow

Wallet Auto-Generation #

Generate secure cryptocurrency wallet addresses and private keys directly from your dashboard — no external tools needed.

How It Works #

Supported Coins #

Shared Address Groups

Private Key Security #

How Keys Are Protected

• AES-256-CBC encryption — keys encrypted before storage
• Per-user key — derived from your password + email
• Never stored in plaintext
• Server-side CSPRNG — random_bytes()

Decrypting Keys Offline

Copy your Decryption Key (64-char hex) and IV (16-char hex) from Account → Private Keys:

echo "ENCRYPTED_KEY_DATA" | openssl enc -aes-256-cbc -d -a \
  -K YOUR_DECRYPTION_KEY_HEX \
  -iv YOUR_IV_HEX

from Crypto.Cipher import AES
import base64

key = bytes.fromhex('YOUR_DECRYPTION_KEY_HEX')
iv  = bytes.fromhex('YOUR_IV_HEX')
cipher = AES.new(key, AES.MODE_CBC, iv)
data = base64.b64decode('ENCRYPTED_KEY_DATA')
print(cipher.decrypt(data).rstrip(b'\x00\x01\x02\x03\x04\x05\x06\x07\x08\x09\x0a\x0b\x0c\x0d\x0e\x0f\x10').decode())

Multiple Addresses

Click 🔑 multiple times — each click appends a new address (comma-separated). With 3+ addresses, customers see exact amounts instead of micro-adjusted unique amounts.

API Reference #

create-transaction #

Creates a new payment transaction for a specific cryptocurrency.

curl -X POST https://cloudpaya.com/api.php \
  -d "api-key=YOUR_API_KEY" \
  -d "function=create-transaction" \
  -d "amount=100" \
  -d "cryptocurrency_code=usdt_tron" \
  -d "currency_code=USD" \
  -d "external_reference=order_12345" \
  -d "title=Pro Subscription"

{
  "success": true,
  "response": [
    456,               // Transaction ID
    "100.00123",       // Crypto amount
    "TRx1234...",      // Wallet address
    3,                 // Required confirmations
    "encrypted..."     // Encrypted data
  ]
}

payment-link #

Generates a hosted payment page URL for an existing transaction.

{
  "success": true,
  "response": "https://cloudpaya.com/id/ENCRYPTED_ID?cloud=YOUR_API_KEY"
}

get-transaction #

Retrieves details of a specific transaction by ID.

{
  "success": true,
  "response": {
    "id": "456",
    "from": "",
    "to": "TRx1234...",
    "hash": "",
    "title": "Pro Subscription",
    "amount": "100.00123",
    "amount_fiat": "100",
    "cryptocurrency": "usdt_tron",
    "currency": "USD",
    "external_reference": "order_12345",
    "creation_time": "2025-12-11 10:30:00",
    "status": "P"
  }
}

get-transactions #

Retrieves a paginated list of transactions with optional filters.

check-transactions #

Checks blockchain and updates a transaction's status.

get-balances #

Returns wallet balances for all configured cryptocurrencies.

get-settings #

Retrieves your account settings.

save-settings #

Updates your account settings (wallet addresses, webhook URL, etc.).

curl -X POST https://cloudpaya.com/api.php \
  -d "api-key=YOUR_API_KEY" \
  -d "function=save-settings" \
  -d 'settings={"address-btc":"bc1q...","address-eth":"0x...","webhook":"https://yoursite.com/webhook"}'

Webhook Setup #

Receive real-time notifications when transaction status changes.

1. Log in to your Dashboard
2. Go to Settings → General
3. Set Webhook URL (e.g. https://yoursite.com/webhook/cloudpaya)
4. Set a Webhook Secret Key
5. Save settings

Webhook Payload #

CloudPaya sends a POST request with JSON body when a transaction status changes:

{
  "transaction": {
    "id": "456",
    "hash": "0xabc123...",
    "from": "TRx9876...",
    "to": "TRx1234...",
    "amount": "100.00123",
    "amount_fiat": "100",
    "cryptocurrency": "usdt_tron",
    "currency": "USD",
    "external_reference": "order_12345",
    "title": "Pro Subscription",
    "status": "C",
    "creation_time": "2025-12-11 10:30:00",
    "confirmations": 3
  }
}

Signature Verification #

Verify the X-Signature header to ensure the webhook is from CloudPaya:

<?php
$webhook_secret = 'your_secret_key';
$payload = file_get_contents('php://input');
$signature = $_SERVER['HTTP_X_SIGNATURE'] ?? '';
$expected = hash_hmac('sha256', $payload, $webhook_secret);

if (hash_equals($expected, $signature)) {
    $data = json_decode($payload, true);
    $transaction = $data['transaction'];

    if ($transaction['status'] === 'C') {
        // Payment confirmed — fulfill order
        $order_id = $transaction['external_reference'];
    }

    http_response_code(200);
    echo 'OK';
} else {
    http_response_code(401);
    echo 'Invalid signature';
}

const crypto = require('crypto');

app.post('/webhook/cloudpaya', (req, res) => {
  const secret = 'your_secret_key';
  const payload = JSON.stringify(req.body);
  const signature = req.headers['x-signature'];

  const expected = crypto
    .createHmac('sha256', secret)
    .update(payload)
    .digest('hex');

  if (crypto.timingSafeEqual(Buffer.from(expected), Buffer.from(signature))) {
    const { transaction } = req.body;
    if (transaction.status === 'C') {
      // Payment confirmed — fulfill order
    }
    res.status(200).send('OK');
  } else {
    res.status(401).send('Invalid signature');
  }
});

Plugins & Integrations #

Ready-to-use plugins for the most popular platforms. All free, all supporting 50+ cryptocurrencies.

WordPress Plugin #

Installation

1. Download cloudpaya-wordpress.zip
2. WordPress Admin → Plugins → Add New → Upload Plugin
3. Upload ZIP → Install Now → Activate
4. Settings → CloudPaya → enter API Key, Checkout ID, Currency

Shortcode

[cloudpaya_pay amount="29.99" currency="USD" title="Premium Plan" description="Monthly subscription" reference="order_123" redirect="https://yoursite.com/thank-you"]

Webhook URL

https://yoursite.com/wp-json/cloudpaya/v1/webhook

WooCommerce Plugin #

Installation

1. Download cloudpaya-woocommerce.zip
2. WordPress Admin → Plugins → Add New → Upload
3. WooCommerce → Settings → Payments → enable CloudPaya Crypto

How It Works

1. Customer selects "Pay with Crypto" at checkout
2. Order created with "Pending" status
3. Customer redirected to CloudPaya (or embedded widget)
4. Webhook marks order as Completed

Webhook URL

https://yoursite.com/wc-api/cloudpaya_webhook

PrestaShop Module #

Installation

1. Download cloudpaya-prestashop.zip
2. Admin → Modules → Module Manager → Upload
3. Configure: CloudPaya URL, API Key, Checkout ID

Webhook URL

https://yourshop.com/module/cloudpaya/validation

Magento 2 Extension #

Installation

1. Download cloudpaya-magento2.zip
2. Extract to app/code/Cloudpaya/Payment/
3. Run:

php bin/magento module:enable Cloudpaya_Payment
php bin/magento setup:upgrade
php bin/magento cache:clean

Configure in Stores → Configuration → Sales → Payment Methods → CloudPaya

Webhook URL

https://yourstore.com/cloudpaya/webhook

OpenCart Extension #

Installation

1. Download cloudpaya-opencart.zip
2. Extract → copy admin/ + catalog/ to OpenCart root
3. Extensions → Payments → Install CloudPaya → Edit → Enable

Webhook URL

https://yourstore.com/index.php?route=extension/payment/cloudpaya/webhook

WHMCS Gateway #

Installation

1. Download cloudpaya-whmcs.zip
2. Copy files to modules/gateways/cloudpaya.php and modules/gateways/callback/cloudpaya.php
3. Setup → Payments → Payment Gateways → activate CloudPaya

Webhook URL

https://yourwhmcs.com/modules/gateways/callback/cloudpaya.php

Easy Digital Downloads #

Installation

1. Download cloudpaya-edd.zip
2. WordPress Admin → Plugins → Upload → Activate
3. Downloads → Settings → Payment Gateways → enable CloudPaya

Webhook URL

https://yoursite.com/wp-json/cloudpaya-edd/v1/webhook

Shopify Integration #

Installation

1. Download cloudpaya-shopify.zip
2. Shopify Admin → Online Store → Themes → Edit Code
3. Under Snippets, add new snippet: cloudpaya-pay
4. Paste contents of cloudpaya-pay.liquid
5. Edit config at top:

{% assign cloudpaya_url = 'https://cloudpaya.com/' %}
{% assign cloudpaya_checkout_id = '1' %}

In your product template, add:

{% render 'cloudpaya-pay', product: product %}

Common Configuration #

Prerequisites for All Plugins

1. CloudPaya Account (free)
2. API Key from Dashboard → Settings
3. Checkout Form ID from Dashboard → Checkouts
4. Wallet addresses configured in Settings

Webhook Flow

1. CloudPaya sends POST to your webhook URL with transaction data
2. Plugin verifies Webhook Secret
3. Order marked as Paid / Completed

Swagger UI #

Interactive API explorer — try endpoints directly from your browser.