Get Deposit

Query the status of a deposit and its settlement data.

GET/v1/api/deposit/:id

Path Parameters

idstring (UUID)Required

Deposit ID returned by POST /deposit

Example

curl https://apilbrl.liqora.io/v1/api/deposit/f1553ee9-7d4e-4d06-8c6e-3b944e361c75 \
  -H "Authorization: Bearer lqr_YOUR_TOKEN"

Response

Response fields

idstring (UUID)Required

Deposit ID

statusstringRequired

Status: WAITING_PAYMENT, PIX_CONFIRMED, SETTLEMENT_CREATED, TX_SENT, FINALIZED, FAILED

amountnumberRequired

Amount in BRL

amountInCentsintegerRequired

Amount in cents

feeAmountnumberRequired

Liqora fee

netAmountnumberRequired

Net amount

qrCodeTextstringRequired

PIX copy-paste string

destinationAddressstringRequired

Destination Liquid address

settlementobject | nullRequired

Settlement data (null if not yet started)

settlement.liquidTxidstringOptional

Transaction ID on the Liquid Network

settlement.statusstringOptional

Settlement status

confirmedAtstring | nullRequired

Confirmation timestamp (ISO 8601)

createdAtstringRequired

Creation timestamp (ISO 8601)

Waiting for payment

Response200

{
  "id": "f1553ee9-7d4e-4d06-8c6e-3b944e361c75",
  "status": "WAITING_PAYMENT",
  "amount": 10,
  "amountInCents": 1000,
  "feeAmount": 0.1,
  "netAmount": 9.9,
  "qrCodeText": "00020101021226710014br.gov.bcb.pix...",
  "destinationAddress": "tlq1qqwpzsxc3cuq3q7z9ywgsxe76sz...",
  "splitAddress": null,
  "splitPercent": null,
  "settlement": null,
  "confirmedAt": null,
  "createdAt": "2026-02-12T08:40:19.307Z"
}

Finalized deposit

Response200

{
  "id": "f1553ee9-7d4e-4d06-8c6e-3b944e361c75",
  "status": "FINALIZED",
  "amount": 10,
  "amountInCents": 1000,
  "feeAmount": 0.1,
  "netAmount": 9.9,
  "qrCodeText": "00020101021226710014br.gov.bcb.pix...",
  "destinationAddress": "tlq1qqwpzsxc3cuq3q7z9ywgsxe76sz...",
  "splitAddress": null,
  "splitPercent": null,
  "settlement": {
    "liquidTxid": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2",
    "status": "FINALIZED"
  },
  "confirmedAt": "2026-02-12T08:42:30.000Z",
  "createdAt": "2026-02-12T08:40:19.307Z"
}

Deposit Status Flow

WAITING_PAYMENTQR Code generated, awaiting PIX payment

PIX_CONFIRMEDPIX received, processing

SETTLEMENT_CREATEDSettlement created

TX_SENTL-BRL sent on the Liquid Network

FINALIZEDDeposit complete, L-BRL confirmed