Getting Started

Overview

The Hodle API lets you accept Bitcoin Lightning payments and trigger PIX payouts programmatically.

Two main flows:

1. Deposit -- Convert BRL to crypto (DEPIX, LBTC, or Lightning) and send to an address.
2. Lightning Invoice -- Generate a Lightning invoice that, once paid, triggers a PIX payout.

Base URL

https://api.hodle.com.br

Quick Start

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

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

Next Steps

• Authentication -- How to authenticate your requests.
• Deposit Asset -- Create deposits for crypto assets.
• Lightning Invoice -- Create Lightning invoices for PIX payouts.
• Webhooks -- Receive real-time notifications.