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

BlockPurposeReference
API keyAuthenticate your platform.Authentication
SubaccountSeparate each customer's account.Subaccounts
KYCVerify identity before moving money.KYC
WalletHold and transfer crypto.Wallet · Wallet Keys
AssetsChoose supported tokens and networks.Assets & Networks
DepositBuy crypto with Pix.Deposit Asset
PayoutPay Pix from crypto.Wallet Payout
LightningIssue an invoice that settles to Pix.Lightning Invoice
WebhooksReceive status updates.Webhooks

The integration lifecycle

  1. Get an API key from Hodle.
  2. Create a subaccount and complete KYC.
  3. Create a wallet and retain its signing credentials.
  4. Fund it through Pix or an external transfer.
  5. Transfer crypto or pay Pix.
  6. Reconcile using Account Statement and webhooks.

KYC must be APPROVED before deposits or payouts.

Base URL & auth

https://api.hodle.com.br
Authorization: Bearer YOUR_API_KEY

API 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.

Where to next