PayPerQ Topup API Documentation

The PayPerQ API allows users to programmatically create deposit invoices and top up their account balances using various payment methods including Bitcoin (Lightning), Bitcoin (on-chain), Monero, Litecoin, and Liquid Bitcoin.

API Endpoints

Base URL

https://api.ppq.ai

POST /topup/create/{method}

Create a topup invoice for the specified payment method.

Methods: btc-lightning, btc, ltc, lbtc, xmr

Example: Create Bitcoin Lightning Topup (USD)

curl -X POST https://api.ppq.ai/topup/create/btc-lightning \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"amount": 1000, "currency": "SATS"}'  # Also supports "BTC" and "USD" as currency

GET /topup/status/{invoice_id}

Check the status of a topup invoice.

Example:

curl -X GET https://api.ppq.ai/topup/status/BTCPayInvoiceId123 \
  -H "Authorization: Bearer YOUR_API_KEY"

GET /topup/payment-methods

Get a list of all supported payment methods with their limits and supported currencies.

Example:

curl -X GET https://api.ppq.ai/topup/payment-methods

POST /accounts/create

Create a new account, which returns a new credit_id and an api_key.

Example:

curl -X POST https://api.ppq.ai/accounts/create

POST /credits/balance

Get the current credit balance for your account.

Example:

curl -X POST "https://api.ppq.ai/credits/balance" \
  -H "Content-Type: application/json" \
  -d '{"credit_id":"4af59b9d-f6ec-4531-82f7-ce776d49e207"}'

More Usage Examples

Example 2: Create Bitcoin On-Chain Topup (BTC)

curl -X POST https://api.ppq.ai/topup/create/btc \
  -H "api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"amount": 0.001, "currency": "BTC"}'

Example 3: Create Monero Topup

curl -X POST https://api.ppq.ai/topup/create/xmr \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"amount": 50.00, "currency": "USD"}'

Limits

Bitcoin Lightning (btc-lightning)

Currencies: USD, BTC, SATS
USD Limits: $0.10 - $1,000
BTC Limits: 0.000001 - 0.01 BTC
SATS Limits: 100 - 1,000,000 SATS
Expiration: 15 minutes
Bonus: 5% Lightning fee bonus

Bitcoin On-Chain (btc)

Currencies: USD, BTC
USD Limits: $10 - $10,000
BTC Limits: 0.0001 - 0.01 BTC
Expiration: 60 minutes

Litecoin (ltc)

Currencies: USD, LTC
USD Limits: $2 - $1,000
LTC Limits: 0.03 - 100 LTC
Expiration: 60 minutes

Liquid Bitcoin (lbtc)

Currencies: USD, LBTC
USD Limits: $2 - $10,000
LBTC Limits: 0.00005 - 0.1 LBTC
Expiration: 60 minutes

Monero (xmr)

Currencies: USD, XMR
USD Limits: $5 - $10,000
XMR Limits: 0.01 - 50 XMR
Expiration: 60 minutes

Support

For API questions, please use the chat widget in the bottom right of the page.