Developer Documentation

API Endpoints

http://www.bitcoincheckout.io/api/payments/create/

Fields

amount_usd Required (number)
order_id Required (string, unique per shop)
shop_id Conditionally required (UUID; required if you have multiple active shops; optional if you have exactly one)
customer_email Optional (email)
customer_name Optional (string)
expires_minutes Optional Default: 60 (int)
on_confirm_url Optional (URL)
items Optional (array of objects; e.g., [{name, quantity, amount_usd}])

import requests

# Create Payment
def create_payment(amount_usd, customer_email, shop_id, order_id, customer_name=None, on_confirm_url=None, items=None):
    url = "http://www.bitcoincheckout.io/api/payments/create/"
    headers = {
        "Authorization": "Bearer YOUR_API_KEY",
        "Content-Type": "application/json"
    }
    data = {
        "amount_usd": amount_usd,
        "customer_email": customer_email,
        "shop_id": shop_id,
        "order_id": order_id,
    }
    if customer_name: data["customer_name"] = customer_name
    if on_confirm_url: data["on_confirm_url"] = on_confirm_url
    if items: data["items"] = items

    response = requests.post(url, json=data, headers=headers)
    return response.json()

# Example usage
payment = create_payment(50.00, "customer@example.com", "your-shop-id", "ORD-2025-0001")
print(f"Payment URL: {payment['checkout_url']}")

const axios = require('axios');

// Create Payment
async function createPayment(amountUsd, customerEmail, shopId) {
    try {
        const response = await axios.post(
            'http://www.bitcoincheckout.io/api/payments/create/',
            {
                amount_usd: amountUsd,
                customer_email: customerEmail,
                shop_id: shopId,
                order_id: 'ORD-2025-0001',
                items: [ { name: 'T-Shirt', quantity: 2, amount_usd: 10.00 } ]
            },
            {
                headers: {
                    'Authorization': 'Bearer YOUR_API_KEY',
                    'Content-Type': 'application/json'
                }
            }
        );
        return response.data;
    } catch (error) {
        console.error('Error creating payment:', error);
        throw error;
    }
}

// Example usage
(async () => {
    const payment = await createPayment(50.00, 'customer@example.com', 'your-shop-id');
    console.log(`Payment URL: ${payment.checkout_url}`);
})();

<?php

// Create Payment
function createPayment($amountUsd, $customerEmail, $shopId) {
    $url = 'http://www.bitcoincheckout.io/api/payments/create/';
    $data = [
        'amount_usd' => $amountUsd,
        'customer_email' => $customerEmail,
        'shop_id' => $shopId,
        'order_id' => 'ORD-2025-0001',
        'items' => [ [ 'name' => 'T-Shirt', 'quantity' => 2, 'amount_usd' => 10.00 ] ]
    ];

    $headers = [
        'Authorization: Bearer YOUR_API_KEY',
        'Content-Type: application/json'
    ];

    $ch = curl_init();
    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch, CURLOPT_POST, true);
    curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
    curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

    $response = curl_exec($ch);
    curl_close($ch);

    return json_decode($response, true);
}

// Example usage
$payment = createPayment(50.00, 'customer@example.com', 'your-shop-id');
echo "Payment URL: " . $payment['checkout_url'] . "\n";

?>

# Create Payment
curl -X POST http://www.bitcoincheckout.io/api/payments/create/ \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "amount_usd": 50.00,
    "customer_email": "customer@example.com",
    "shop_id": "your-shop-id",
    "order_id": "ORD-2025-0001",
    "items": [ { "name": "T-Shirt", "quantity": 2, "amount_usd": 10.00 } ]
  }'

http://www.bitcoincheckout.io/api/payments/{payment_id}/

import requests

# Check Payment Status
def check_payment(payment_id):
    url = f"http://www.bitcoincheckout.io/api/payments/{payment_id}/"
    headers = {"Authorization": "Bearer YOUR_API_KEY"}

    response = requests.get(url, headers=headers)
    return response.json()

# Example usage
status = check_payment("payment-id-here")
print(f"Status: {status['status']}")
print(f"Received: {status['received_btc']} BTC")
print(f"Confirmations: {status['confirmations']}")

const axios = require('axios');

// Check Payment Status
async function checkPayment(paymentId) {
    try {
        const response = await axios.get(
            `http://www.bitcoincheckout.io/api/payments/${paymentId}/`,
            {
                headers: {
                    'Authorization': 'Bearer YOUR_API_KEY'
                }
            }
        );
        return response.data;
    } catch (error) {
        console.error('Error checking payment:', error);
        throw error;
    }
}

// Example usage
(async () => {
    const status = await checkPayment('payment-id-here');
    console.log(`Status: ${status.status}`);
    console.log(`Received: ${status.received_btc} BTC`);
    console.log(`Confirmations: ${status.confirmations}`);
})();

<?php

// Check Payment Status
function checkPayment($paymentId) {
    $url = 'http://www.bitcoincheckout.io/api/payments/' . $paymentId . '/';
    $headers = [
        'Authorization: Bearer YOUR_API_KEY'
    ];

    $ch = curl_init();
    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

    $response = curl_exec($ch);
    curl_close($ch);

    return json_decode($response, true);
}

// Example usage
$status = checkPayment('payment-id-here');
echo "Status: " . $status['status'] . "\n";
echo "Received: " . $status['received_btc'] . " BTC\n";
echo "Confirmations: " . $status['confirmations'] . "\n";

?>

# Check Payment Status
curl -X GET http://www.bitcoincheckout.io/api/payments/PAYMENT_ID/ \
  -H "Authorization: Bearer YOUR_API_KEY"

http://www.bitcoincheckout.io/api/shops/

import requests

# Get Shops
def get_shops():
    url = "http://www.bitcoincheckout.io/api/shops/"
    headers = {"Authorization": "Bearer YOUR_API_KEY"}

    response = requests.get(url, headers=headers)
    return response.json()

# Example usage
shops_data = get_shops()
print(f"Total shops: {shops_data['total_shops']}")

for shop in shops_data['shops']:
    print(f"Shop: {shop['name']} (ID: {shop['id']})")

const axios = require('axios');

// Get Shops
async function getShops() {
    try {
        const response = await axios.get(
            'http://www.bitcoincheckout.io/api/shops/',
            {
                headers: {
                    'Authorization': 'Bearer YOUR_API_KEY'
                }
            }
        );
        return response.data;
    } catch (error) {
        console.error('Error getting shops:', error);
        throw error;
    }
}

// Example usage
(async () => {
    const shopsData = await getShops();
    console.log(`Total shops: ${shopsData.total_shops}`);

    shopsData.shops.forEach(shop => {
        console.log(`Shop: ${shop.name} (ID: ${shop.id})`);
    });
})();

<?php

// Get Shops
function getShops() {
    $url = 'http://www.bitcoincheckout.io/api/shops/';
    $headers = [
        'Authorization: Bearer YOUR_API_KEY'
    ];

    $ch = curl_init();
    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

    $response = curl_exec($ch);
    curl_close($ch);

    return json_decode($response, true);
}

// Example usage
$shopsData = getShops();
echo "Total shops: " . $shopsData['total_shops'] . "\n";

foreach ($shopsData['shops'] as $shop) {
    echo "Shop: " . $shop['name'] . " (ID: " . $shop['id'] . ")\n";
}

?>

E-commerce Integrations

Ready-to-use plugins for popular platforms

WooCommerce

WordPress Plugin

Complete payment gateway plugin for WooCommerce stores. Easy installation and configuration.

Shopify

App Integration

Full Shopify app with webhook integration and order management. Deploy to your store.

API Response Examples

200 Create Payment Response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "order_id": "ORD-2025-0001",
  "status": "pending",
  "amount_state": "none",
  "amount_usd": 50.00,
  "amount_btc": "0.0010000",
  "bitcoin_address": "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh",
  "checkout_url": "http://www.bitcoincheckout.io/payments/pay/550e8400-e29b-41d4-a716-446655440000/",
  "success_url": "https://yourapp.com/thank-you?order=ORD-2025-0001",
  "expires_at": "2024-01-01T12:00:00Z",
  "created_at": "2024-01-01T11:00:00Z"
}

200 Payment Status Response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "confirmed",
  "amount_state": "full",
  "amount_usd": 50.00,
  "amount_btc": "0.0010000",
  "received_btc": "0.0010000",
  "confirmations": 3,
  "bitcoin_address": "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh",
  "txid": "a1b2c3d4e5f6789012345678901234567890abcdef",
  "expires_at": "2024-01-01T12:00:00Z",
  "confirmed_at": "2024-01-01T11:45:00Z"
}

200 Get Shops Response

{
  "shops": [
    {
      "id": "1d9673c8-1cd6-4cfd-8a87-7cc09f0e26c6",
      "name": "My Online Store",
      "created_at": "2024-01-01T10:00:00Z"
    },
    {
      "id": "2e8784d9-2de7-5ced-9b98-8dd1af1f37d7",
      "name": "Mobile App Store",
      "created_at": "2024-01-02T14:30:00Z"
    }
  ],
  "total_shops": 2
}

Developer API

Your API Key

Base URL

Authentication

Format