Overview
The path from an API key to deposits, transfers and Pix payouts.
The Hodle API converts between BRL (Pix), Bitcoin Lightning and stablecoins. Use it to create deposits, send Pix payouts, issue Lightning invoices and manage non-custodial wallets.
The building blocks
| Block | Purpose | Reference |
|---|---|---|
| API key | Authenticate your platform. | Authentication |
| Subaccount | Separate each customer's account. | Subaccounts |
| KYC | Verify identity before moving money. | KYC |
| Wallet | Hold and transfer crypto. | Wallet · Wallet Keys |
| Assets | Choose supported tokens and networks. | Assets & Networks |
| Deposit | Buy crypto with Pix. | Deposit Asset |
| Payout | Pay Pix from crypto. | Wallet Payout |
| Lightning | Issue an invoice that settles to Pix. | Lightning Invoice |
| Webhooks | Receive status updates. | Webhooks |
The integration lifecycle
- Get an API key from Hodle.
- Create a subaccount and complete KYC.
- Create a wallet and retain its signing credentials.
- Fund it through Pix or an external transfer.
- Transfer crypto or pay Pix.
- Reconcile using Account Statement and webhooks.
KYC must be APPROVED before deposits or payouts.
Base URL & auth
https://api.hodle.com.brAuthorization: Bearer YOUR_API_KEYAPI keys start with hodle_live_. See Authentication.
Money never moves silently
Listen for webhooks, including KYC_APPROVED, DEPOSIT_ASSET_SUCCESS, PAYOUT_SUCCESSFUL and PAYOUT_FAILED. Verify X-Hodle-Signature before processing events. Use transaction hashes and Pix endToEndId values, when available, for reconciliation.