Deposit Asset

POST /api/deposit/asset

Create a deposit that converts BRL to the specified crypto asset and sends it to the provided address.

Request

curl --request POST \
  --url https://api.hodle.com.br/api/deposit/asset \
  --header "Authorization: Bearer $API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "value": 5000,
    "address": "lnbc500u1pj...",
    "asset": "LIGHTNING",
    "externalId": "my-order-123"
  }'

const res = await fetch('https://api.hodle.com.br/api/deposit/asset', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.HODLE_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    value: 5000,
    address: 'lnbc500u1pj...',
    asset: 'LIGHTNING',
    externalId: 'my-order-123',
  }),
})
const data = await res.json()

import os, requests

res = requests.post(
    "https://api.hodle.com.br/api/deposit/asset",
    headers={
        "Authorization": f"Bearer {os.environ['HODLE_API_KEY']}",
        "Content-Type": "application/json",
    },
    json={
        "value": 5000,
        "address": "lnbc500u1pj...",
        "asset": "LIGHTNING",
        "externalId": "my-order-123",
    },
)
data = res.json()

Body example

POST /api/deposit/asset

{
  "value": 5000,
  "address": "lnbc500u1pj...",
  "asset": "LIGHTNING",
  "externalId": "my-order-123"
}

Parameters

Field	Type	Required	Description
`value`	integer	Yes	Amount in BRL cents. Must be a positive integer.
`address`	string	Yes	Destination address. Liquid address for DEPIX/LBTC, Lightning invoice or LNURL email for LIGHTNING.
`asset`	string	Yes	Asset type: `DEPIX`, `LBTC`, or `LIGHTNING`.
`externalId`	string	No	Your own ID for reconciliation. Must be unique per deposit (idempotency key). A UUID is generated if not provided.

Address Formats

For LIGHTNING assets, the address can be:

A Lightning invoice starting with lnbc, lntb, or lnbcrt
An LNURL email in the format user@domain.com

Response

200 OK

{
  "success": true,
  "externalId": "my-order-123",
  "qrCode": "lnbc500u1pj...",
  "fee": 100,
  "fxRateAtTx": 408000.50,
  "walletCharge": "charge_abc123"
}

Fields

Field	Type	Description
`success`	boolean	Whether the deposit was created.
`externalId`	string	The external ID for reconciliation (your value or auto-generated UUID).
`qrCode`	string \| null	QR code for the deposit.
`fee`	number	Fee charged for the deposit.
`fxRateAtTx`	number	BTC/BRL exchange rate at the time of transaction.
`walletCharge`	string \| null	Wallet charge identifier.

Errors

400 Bad Request

{
  "success": false,
  "error": "Validation failed",
  "details": [
    { "field": "value", "message": "Expected number, received string" }
  ]
}

409 Conflict

{
  "success": false,
  "error": "A deposit with this externalId already exists"
}

Deposit Asset

On this page