# CloudPaya — Complete Documentation

> Non-custodial crypto payment gateway. Accept Bitcoin, USDT, Ethereum, Solana, and 50+ cryptocurrencies with direct wallet settlement.
> Built for SaaS platforms, e-commerce, developers, and businesses in countries where Stripe, PayPal, and traditional gateways are unavailable.
> No KYC. No bank account. No monthly fees. Payments settle directly to your wallet — CloudPaya never holds funds.

- Website: https://cloudpaya.com/
- API Documentation: https://cloudpaya.com/docs/
- OpenAPI Spec (Swagger): https://cloudpaya.com/docs/swagger.json
- Summary: https://cloudpaya.com/llms.txt
- About: https://cloudpaya.com/about
- Security & Transparency: https://cloudpaya.com/security
- Terms of Service: https://cloudpaya.com/terms-of-service
- What is CloudPaya: https://cloudpaya.com/what-is-cloudpaya
- CloudPaya vs Stripe: https://cloudpaya.com/cloudpaya-vs-stripe
- Accept Crypto Payments: https://cloudpaya.com/accept-crypto-payments
- Non-Custodial Gateway: https://cloudpaya.com/non-custodial-crypto-gateway

---

## Product Overview

CloudPaya is a crypto payment gateway — a self-service alternative to Stripe and PayPal that uses cryptocurrency instead of card networks. Merchants add wallet addresses, integrate via REST API or plugins, and receive payments directly on-chain. No intermediary, no custody, no payout delays.

**Problem**: Businesses in Africa, MENA, Latin America, and Southeast Asia cannot access Stripe or PayPal. CloudPaya gives them a payment gateway that works in 195+ countries with zero geographic restrictions.

**How it works**: Customer pays in crypto → blockchain confirms → funds arrive in merchant wallet. Settlement is instant. CloudPaya charges a per-transaction fee (0.5%–1%) and never touches the funds.

CloudPaya provides:

- Non-custodial payments (funds go directly to merchant wallet)
- 50+ cryptocurrencies across 10+ blockchains
- REST API with 40+ endpoints
- Webhook notifications for payment confirmations
- Embeddable JavaScript checkout widget
- 8 platform plugins (WordPress, WooCommerce, Shopify, PrestaShop, Magento, OpenCart, WHMCS, Easy Digital Downloads)
- SaaS multi-tenancy (white-label)
- Tiered pricing: 0.5% + $2.00 for $1,000+, 0.8% + $1.00 for $100–$999, 1% + $0.30 under $100

---

## Authentication

All API requests require an API key passed as either:
- Query parameter: `?api-key=YOUR_KEY`
- POST body parameter: `api-key=YOUR_KEY`

Get your API key from:  Dashboard → Settings → API section.

Base URL: `https://cloudpaya.com/api.php` (or your custom domain if self-hosted)

All requests use POST method to `api.php` with `function` parameter specifying the action.

---

## API Endpoints

### create-transaction
Create a new cryptocurrency payment transaction.

```
POST /api.php
Content-Type: application/x-www-form-urlencoded

function=create-transaction
&amount=50.00
&cryptocurrency_code=ETH
&currency_code=USD
&title=Order #123
&description=Payment for order
&redirect=https://example.com/thank-you
&webhook_url=https://example.com/webhook
```

Parameters:
- `amount` (required): Payment amount
- `cryptocurrency_code` (optional): BTC, ETH, USDT_ERC20, USDT_TRC20, USDT_BSC, SOL, USDC, BNB, LTC, DOGE, etc.
- `currency_code` (optional): USD, EUR, GBP, etc. Default: USD
- `title` (optional): Transaction title
- `description` (optional): Transaction description
- `redirect` (optional): URL to redirect after payment
- `webhook_url` (optional): URL for payment notification
- `note` (optional): Internal note
- `pay_page` (optional): If true, returns a payment page URL instead of raw data

Response: JSON with transaction ID, payment address, amount in crypto, QR code data, and payment page URL.

### payment-link
Generate a hosted payment page URL.

```
POST /api.php
function=payment-link&amount=100&currency_code=USD
```

### get-transaction
Get details of a specific transaction.

```
POST /api.php
function=get-transaction&transaction_id=123
```

### get-transactions
List transactions with optional filters.

```
POST /api.php
function=get-transactions&pagination=0&search=completed&status=C
```

Parameters:
- `pagination` (optional): Page number (0-indexed)
- `search` (optional): Search text
- `status` (optional): C (completed), P (pending), R (refunded), X (expired)

### check-transactions
Check and update status of all pending transactions.

```
POST /api.php
function=check-transactions
```

### get-balances
Get cryptocurrency balances for configured wallets.

```
POST /api.php
function=get-balances
```

### get-settings
Get the current merchant settings.

```
POST /api.php
function=get-settings
```

### save-settings
Update merchant settings.

```
POST /api.php
function=save-settings&settings={"wallet-address":"0x...","btc-wallet-address":"bc1..."}
```

### get-exchange-rates
Get current cryptocurrency exchange rates.

```
POST /api.php
function=get-exchange-rates
```

### get-usd-rates
Get USD conversion rates for all supported cryptocurrencies.

```
POST /api.php
function=get-usd-rates
```

### get-checkouts
List all checkout configurations.

```
POST /api.php
function=get-checkouts
```

### save-checkout
Create or update a checkout.

```
POST /api.php
function=save-checkout&checkout_id=&title=Pro Plan&description=Monthly subscription&amount=29.99&currency=USD
```

### delete-checkout
Delete a checkout by ID.

```
POST /api.php
function=delete-checkout&checkout_id=5
```

### get-fiat-value
Convert crypto amount to fiat value.

```
POST /api.php
function=get-fiat-value&amount=0.5&cryptocurrency_code=ETH&currency_code=USD
```

### refund
Refund a completed transaction.

```
POST /api.php
function=refund&transaction_id=123
```

### get-cryptocurrency-codes
Get list of all supported cryptocurrency codes.

```
POST /api.php
function=get-cryptocurrency-codes
```

### cron
Trigger the cron job to check pending transactions.

```
POST /api.php
function=cron
```

---

## Webhooks

CloudPaya sends HTTP POST notifications to your webhook URL when a transaction is completed.

### Webhook Payload

```json
{
  "id": 123,
  "amount": "50.00",
  "cryptocurrency_code": "ETH",
  "cryptocurrency_amount": "0.025",
  "currency_code": "USD",
  "status": "C",
  "title": "Order #123",
  "hash": "0xabc...",
  "from": "0x...",
  "to": "0x...",
  "external_reference": "order_123",
  "webhook_url": "https://example.com/webhook"
}
```

### Webhook Verification

Verify webhook signatures using the secret key from Dashboard → Settings → Webhook section.

```php
$payload = file_get_contents('php://input');
$signature = $_SERVER['HTTP_X_BOXCOIN_SIGNATURE'];
$secret = 'your_webhook_secret';
$expected = hash_hmac('sha256', $payload, $secret);
if (hash_equals($expected, $signature)) {
    // Webhook is valid
    $data = json_decode($payload, true);
}
```

---

## JavaScript Widget Integration

Embed the CloudPaya checkout widget on any website:

```html
<script src="https://cloudpaya.com/js/client.min.js"></script>
<div id="bxc-pay" data-amount="50" data-currency="USD" data-title="Order #123"></div>
```

Or trigger programmatically:

```javascript
BXC.checkout({
    amount: 50,
    currency: 'USD',
    title: 'Order #123',
    redirect: 'https://example.com/thank-you',
    callback: function(transaction) {
        console.log('Payment completed:', transaction.id);
    }
});
```

---

## Supported Cryptocurrencies

CloudPaya supports 50+ cryptocurrencies across 10+ blockchains:

- **Bitcoin**: BTC
- **Ethereum**: ETH, USDT_ERC20, USDC_ERC20, DAI, SHIB, LINK, UNI, AAVE
- **Binance Smart Chain**: BNB, USDT_BSC, USDC_BSC, BUSD
- **Tron**: TRX, USDT_TRC20, USDC_TRC20
- **Solana**: SOL, USDT_SOL, USDC_SOL
- **Polygon**: MATIC, USDT_POLYGON, USDC_POLYGON
- **Avalanche**: AVAX
- **Arbitrum**: USDT_ARB, USDC_ARB
- **Optimism**: USDT_OP, USDC_OP
- **Base**: USDC_BASE
- **Litecoin**: LTC
- **Dogecoin**: DOGE
- **Bitcoin Cash**: BCH

---

## Platform Plugins

### WordPress / WooCommerce
Download: https://cloudpaya.com/docs/downloads/cloudpaya-wordpress.zip
1. Upload plugin via WordPress Admin → Plugins → Add New
2. Activate and enter your API key in Settings → CloudPaya
3. For WooCommerce: Enable CloudPaya as payment method in WooCommerce → Settings → Payments

### Shopify
Download: https://cloudpaya.com/docs/downloads/cloudpaya-shopify.zip
Integration via Shopify custom payment method.

### PrestaShop
Download: https://cloudpaya.com/docs/downloads/cloudpaya-prestashop.zip

### Magento 2
Download: https://cloudpaya.com/docs/downloads/cloudpaya-magento2.zip

### OpenCart
Download: https://cloudpaya.com/docs/downloads/cloudpaya-opencart.zip

### WHMCS
Download: https://cloudpaya.com/docs/downloads/cloudpaya-whmcs.zip

### Easy Digital Downloads
Download: https://cloudpaya.com/docs/downloads/cloudpaya-edd.zip

---

## Credits & Pricing

Tiered transaction fees based on amount (in USD):

| Transaction Amount | Fee | Fixed Fee |
|---|---|---|
| $0 – $99 | 1.0% | + $0.30 |
| $100 – $999 | 0.8% | + $1.00 |
| $1,000+ | 0.5% | + $2.00 |

- No setup fees
- No monthly fees
- No withdrawal fees
- No hidden charges
- Pre-purchase credits to pay fees (deducted from credit balance)

---

## Wallet Auto-Generation

CloudPaya can automatically generate unique receiving addresses per transaction using HD wallets (BIP44/BIP84). This enables:

- Unique address per customer/transaction
- Automatic payment matching
- No manual address management

Supported for: ETH + all ERC-20 tokens, BNB + BEP-20, TRX + TRC-20, SOL + SPL, BTC (SegWit), LTC, DOGE, BCH, MATIC + Polygon tokens, AVAX, ARB, OP, BASE.

Private keys are encrypted with AES-256-CBC. Decryption requires the merchant's encryption key (Dashboard → Settings → Advanced).

---

## Comparison with Alternatives

| Feature | CloudPaya | Stripe | PayPal | Coinbase Commerce |
|---|---|---|---|---|
| Crypto Payments | 50+ coins | USDC only | No | 10+ coins |
| Non-Custodial | Yes | No | No | No |
| KYC Required | No | Yes | Yes | Yes |
| Global Availability | 195+ countries | ~46 countries | ~200 | ~100 |
| Transaction Fees | 0.5%–1% + fixed | 2.9% + 30¢ | 2.99% | 1% |
| Instant Settlement | Yes (on-chain) | 2-7 days | 1-3 days | Varies |
| Self-hosted Option | Yes | No | No | No |
| Platform Plugins | 8 | 15+ | 10+ | 3 |
| REST API | 40+ endpoints | 300+ | 200+ | 20+ |

---

## Frequently Asked Questions

### What is CloudPaya?
CloudPaya is a non-custodial crypto payment gateway that lets businesses accept Bitcoin, Ethereum, USDT, and 50+ cryptocurrencies with direct wallet settlement.

### How do I accept crypto payments on my website?
Sign up at cloudpaya.com, add your wallet addresses, and integrate using the REST API, JavaScript widget, or one of 8 platform plugins.

### Is CloudPaya a good Stripe alternative?
Yes. CloudPaya is designed for businesses that need crypto payments, operate in unsupported countries, or want lower fees (0.5%–1% vs 2.9%).

### What cryptocurrencies does CloudPaya support?
Bitcoin, Ethereum, USDT (ERC-20, TRC-20, BEP-20), USDC, Solana, BNB, Litecoin, Dogecoin, and 40+ more across 10+ blockchains.

### Does CloudPaya work in Africa and the Middle East?
Yes. CloudPaya works in 195+ countries with no geographic restrictions.

### Is CloudPaya non-custodial?
Yes. CloudPaya never holds merchant funds. Payments go directly from customer wallet to merchant wallet.

### What does CloudPaya cost?
Tiered per-transaction fees: 1% + $0.30 for under $100, 0.8% + $1.00 for $100–$999, 0.5% + $2.00 for $1,000+. No setup fees, monthly fees, or hidden charges.

### Do I need a bank account?
No. CloudPaya settles payments directly to your crypto wallet.

### Does CloudPaya have an API?
Yes. REST API with 40+ endpoints. Full docs at https://cloudpaya.com/docs/

### Can I use CloudPaya for SaaS?
Yes. Multi-tenancy with white-label processing, per-client analytics, and subscription management.

---

## Resources

- Website: https://cloudpaya.com/
- About: https://cloudpaya.com/about
- Security & Transparency: https://cloudpaya.com/security
- API Documentation: https://cloudpaya.com/docs/
- OpenAPI Spec: https://cloudpaya.com/docs/swagger.json
- What is CloudPaya: https://cloudpaya.com/what-is-cloudpaya
- CloudPaya vs Stripe: https://cloudpaya.com/cloudpaya-vs-stripe
- Accept Crypto Payments: https://cloudpaya.com/accept-crypto-payments
- Non-Custodial Crypto Gateway: https://cloudpaya.com/non-custodial-crypto-gateway
- Privacy Policy: https://cloudpaya.com/privacy.html
- Terms of Service: https://cloudpaya.com/terms-of-service