Developer Documentation
Integrate paybee's crypto payment infrastructure into your application. RESTful API with comprehensive SDKs.
🚀 Quick Start
// 1. Get your API key from the dashboard
// 2. Set the base URL
const BASE_URL = "https://api.paybee.network/v1";
// 3. Make your first API call
const res = await fetch(BASE_URL + "/status");
🔑 Authentication
All API requests require your API key in the request header:
x-api-key: pb_your_api_key_here
API Endpoints
| Method | Endpoint | Description | Auth |
|---|---|---|---|
| GET | /v1/status | Check API and service health status | Public |
| GET | /v1/currencies | Get list of all supported cryptocurrencies | 🔑 Key |
| GET | /v1/estimate | Get estimated price for a currency pair | 🔑 Key |
| GET | /v1/min-amount | Get minimum payment amount for a currency pair | 🔑 Key |
| POST | /v1/payment | Create a new payment transaction | 🔑 Key |
| GET | /v1/payment/{id} | Get payment status and details | 🔑 Key |
| POST | /v1/invoice | Create a payment invoice with hosted checkout | 🔑 Key |
| POST | /v1/payout | Send a cryptocurrency payout | 🔑 Key |
| GET | /v1/balance | Get custody wallet balances | 🔑 Key |
Create Payment — Example
REQUEST
POST /v1/payment
x-api-key: pb_xxx
Content-Type: application/json
{
"price_amount": 100.00,
"price_currency": "usd",
"pay_currency": "btc",
"order_id": "ORD-1234"
}
RESPONSE
201 Created
{
"payment_id": "pay_abc123",
"payment_status": "waiting",
"pay_address": "bc1q...",
"pay_amount": 0.00154,
"price_amount": 100.00,
"price_currency": "usd"
}
Webhooks (IPN)
Configure your IPN callback URL in the dashboard to receive real-time payment status updates. All webhook payloads are signed with HMAC-SHA512 using your IPN secret key.
Verify the signature by comparing the x-paybee-sig header against the HMAC-SHA512 hash of the sorted JSON payload using your IPN secret key.
🧪 Sandbox Environment
Test your integration without real funds using our sandbox environment.
https://api-sandbox.paybee.network/v1