Getting Started

The Hodle API lets you accept Bitcoin Lightning payments, run on-ramp/off-ramp flows between BRL and crypto, and trigger PIX payouts programmatically.

Base URL

https://api.hodle.com.br

Authentication

Every request needs an API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

See Authentication for full details.

Quick start

curl -X POST https://api.hodle.com.br/api/lightning/invoice \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "value": 1000,
    "pixKey": "user@email.com",
    "pixKeyType": "EMAIL"
  }'

The response includes an invoice field. Once paid, a PIX payout is sent to the provided key.

Where to next

• Use cases: Stable ↔ PIX · Lightning ↔ PIX
• Reference: KYC · Wallet · Deposit · Payout · Webhooks