Boleto

Issuance of boletos and tracking of clearing.

The boleto is the payment slip regulated by the Central Bank of Brazil, payable across the banking network and its correspondents.

​

Issuance

The POST /boleto operation issues the boleto. The amount (amountInCents) and the identification of the payer (customer.documentType and customer.document) are required. Sending the payer’s address in customer.billingAddress is recommended.

curl -X POST https://api.fincle.com.br/boleto \
  -H "Authorization: Bearer $FINCLE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "amountInCents": 480000,
    "description": "Invoice no. 2026/001042",
    "customer": {
      "name": "Distribuidora Vale Verde Ltda",
      "email": "[e-mail]",
      "documentType": "cnpj",
      "document": "27481396000192",
      "billingAddress": {
        "street": "Avenida Paulista",
        "number": "1374",
        "neighborhood": "Bela Vista",
        "city": "São Paulo",
        "state": "SP",
        "zipCode": "01310100"
      }
    }
  }'

{
  "success": true,
  "message": "Transação criada com sucesso",
  "data": {
    "id": "cmddiqpxo09zf1yju2kqkhgga",
    "boleto": {
      "url": "https://boleto.example.com/cmddiqpxo09zf1yju2kqkhgga",
      "barcode": "34191790010104351004791020150008291070480000",
      "digitableLine": "34191.79001 01043.510047 91020.150008 2 91070480000",
      "dueAt": "2026-11-27"
    },
    "status": "pending",
    "fees": 349
  }
}

Field	Description
boleto.url	URL for viewing and printing the boleto.
boleto.barcode	Barcode, with 44 positions.
boleto.digitableLine	Digitable line, the numeric representation of the barcode.
boleto.dueAt	Due date.

​

Clearing

The transaction is created in the pending status and moves to paid when the boleto is cleared, which is communicated by the transaction_paid event. Bank clearing is not instantaneous, so the notification may occur on a date later than that of the payment.

The period between clearing and the credit to the account balance is given in the boleto.receiveDays field of the GET /fees operation.

​

Restriction on refunds

Amounts paid by boleto cannot be refunded by the platform. Where a return to the payer is due, it must be made by other means, such as a bank transfer.