Boleto Cloud API

Name: Boleto Cloud API
Brand: Boleto Cloud API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentPaymentsBilling Subscriptionsbasic12 EndpointsREST

For Agents

Issue Brazilian boletos bancários with Pix, modify or cancel them, run batch issuance, and exchange CNAB remittance and return files through Boleto Cloud.

Use for: I need to issue a boleto bancário for 250 BRL, Generate a boleto with a Pix QR code attached, Change the due date of an outstanding boleto, Cancel a boleto that the customer no longer needs to pay

Not supported: Does not handle credit card processing, Pix without an underlying boleto, or international payments - use for Brazilian boleto issuance and lifecycle management only.

Jentic publishes the only available OpenAPI specification for Boleto Cloud API, keeping it validated and agent-ready. Boleto Cloud is a Brazilian payment service that issues boletos bancários with optional Pix QR codes, registers them automatically with the major Brazilian banks, and exposes the full lifecycle through a REST API. Use it to create boletos individually or in batch, modify the due date, grant a discount, write off a boleto, and exchange CNAB remittance and return files. The API also supports carnês (boletos with multiple installments) for subscription-style billing.

Jentic One on Github View OpenAPI Document

Install Jentic One Beta

Connect the Boleto Cloud API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Boleto Cloud API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fboleto.cloud%2Fboleto-cloud" | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fboleto.cloud%2Fboleto-cloud" | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Boleto Cloud API.

Issue a registered boleto bancário with optional Pix QR code for a Brazilian payer

Modify the due date or grant a discount on a previously issued boleto

Write off (baixa) a boleto so it is removed from the bank's cobrança register

Issue a carnê - a single document with multiple installment boletos for subscription billing

Submit boletos in batch to register many at once instead of one call per slip

GET STARTED

Start building with Boleto Cloud API

Explore with Jentic One

View OpenAPI Document

Use Cases

Patterns agents use Boleto Cloud API for, with concrete tasks.

★ Subscription Billing with Carnê

Issue a single carnê with twelve installment boletos when a customer signs up for an annual subscription, so they receive one document and twelve monthly payment slips. POST /carnes creates the full series in one call. Brazilian SaaS and education businesses use this to bill annual customers without storing card data.

POST /carnes for customer CPF 12345678901 with 12 installments of 99 BRL starting 2026-07-15

Bulk Boleto Issuance for Monthly Billing Cycles

Submit thousands of boletos in a single batch on the day of the month when invoices go out, instead of making one HTTP call per customer. POST /batch/boletos accepts the full set, validates each, and registers them with the chosen bank. Removes the latency and error-handling cost of high-volume billing runs.

POST /batch/boletos with the JSON array of 500 customer slips for the June billing run

Lifecycle Management of Outstanding Boletos

Adjust the due date when a customer asks for a few extra days, grant a discount for early payment, or write off a boleto that was issued in error. PUT /boletos/{token}/vencimento, /boletos/{token}/abatimento, and /boletos/{token}/baixa cover these mid-lifecycle changes. Saves the bookkeeping team from contacting the bank directly for each adjustment.

PUT /boletos/abc123/vencimento with new due_date 2026-07-30

AI Agent Brazilian Receivables

An AI agent uses Jentic to discover Boleto Cloud operations, issues boletos for Brazilian customers, and writes them off when paid through CNAB return processing. Credentials live in your Jentic One instance so the basic-auth API key never enters the prompt. Replaces multi-day bank-by-bank cobrança integration with a single search-load-execute cycle.

Search Jentic for 'issue a boleto bancário', load the operation, and execute it for a 350 BRL invoice due in 14 days

Key Endpoints

12 endpoints — jentic publishes the only available openapi specification for boleto cloud api, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

POST

/boletos

Create a boleto

GET

/boletos/{token}

Retrieve the original copy of a boleto

PUT

/boletos/{token}/vencimento

Modify the due date

PUT

/boletos/{token}/baixa

Write off (cancel) a boleto

POST

/carnes

Create a carnê with multiple installments

POST

/batch/boletos

Create boletos in batch

POST

/arquivos/cnab/remessas

Submit a CNAB remittance file

POST

/arquivos/cnab/retornos

Submit CNAB return files for reconciliation

POST

/boletos

Create a boleto

GET

/boletos/{token}

Retrieve the original copy of a boleto

PUT

/boletos/{token}/vencimento

Modify the due date

PUT

/boletos/{token}/baixa

Write off (cancel) a boleto

POST

/carnes

Create a carnê with multiple installments

POST

/batch/boletos

Create boletos in batch

POST

/arquivos/cnab/remessas

Submit a CNAB remittance file

POST

/arquivos/cnab/retornos

Submit CNAB return files for reconciliation

Why Jentic?

What agents get from Jentic-routed access to this vendor.

Setup

Wiring Boleto Cloud by hand means constructing its HTTP Basic auth header from your API key and choosing between the production and sandbox hosts yourself. Through Jentic you install once, import Boleto Cloud from the API Directory, store the API key once, and your agent calls it.

Permission scoping

Boleto Cloud puts the boleto token in the URL path (/boletos/{token}/vencimento, /boletos/{token}/baixa), so a rule can pin your agent to acting on a given boleto: it can read it or update its due date and nothing else. You choose the operations it may call, so settling a boleto with baixa is not included unless you add it.

Credential isolation

Your Boleto Cloud API key is stored once, encrypted, by your own Jentic One instance and injected into the Basic auth header at execution time. It never enters the agent's prompt, logs, or context.

Intent-based discovery

Agents search Jentic by intent such as 'issue a boleto' or 'create a carnê', and Jentic returns the matching Boleto Cloud operation with its input schema so the agent calls the right endpoint without reading the Portuguese-language docs.

FAQs

Specific to using Boleto Cloud API through Jentic.

Why is there no official OpenAPI spec for Boleto Cloud API?

Boleto Cloud does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Boleto Cloud API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

What authentication does the Boleto Cloud API use?

Boleto Cloud uses HTTP Basic authentication with your API key as the username. Through Jentic the credential is held in the encrypted vault and only a scoped, short-lived token reaches the agent context.

Can I issue a boleto with a Pix QR code attached?

Yes. POST /boletos accepts the boleto details and Boleto Cloud will optionally include a Pix QR code on the same slip when configured for the payer's bank. The returned token identifies the boleto for later lifecycle calls.

How do I issue a carnê with multiple installments?

POST /carnes with the customer details and the list of installments. Boleto Cloud creates the full series of boletos as one carnê document, useful for annual subscription or tuition billing.

What are the rate limits for the Boleto Cloud API?

Formal rate limits are not declared in the OpenAPI spec. For high-volume issuance, prefer POST /batch/boletos over many single calls - batch is the supported path for monthly billing runs.

How do I reconcile paid boletos through Jentic?

Search Jentic for 'submit CNAB return file', load the POST /arquivos/cnab/retornos operation, then execute it with the bank's daily return file. Boleto Cloud parses the file and updates registration status for each boleto.

Can I limit what my agent is allowed to do with the Boleto Cloud API?

Yes. Because you run Jentic One yourself, your own rules decide which Boleto Cloud operations and credentials the agent may use. Since the boleto token sits in the URL path, such as /boletos/{token}/vencimento and /boletos/{token}/baixa, you can pin the agent to a specific boleto and let it only read or change the due date. Destructive operations like writing off a boleto with baixa, or issuing new boletos and carnês, stay off limits until you explicitly grant them.

Boleto Cloud API

Connect the Boleto Cloud API to your agent

Capabilities

Start building with Boleto Cloud API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs