canonical: https://jentic.com/apis/bb.com.br/main

# Bb Cobranças API

The Cobranças API registers and manages Banco do Brasil collection boletos, the bank slips Brazilian businesses issue to get paid. It lists, details, and amends boletos, handles their operational write-off and cancellation, and generates or cancels a Pix charge attached to a boleto so a payer can settle by instant transfer. Settlement feedback is available through the operational baixa flow tied to a billing agreement.

## For AI agents

Register, list, detail, and amend Banco do Brasil collection boletos, run their write-off flow, and generate or cancel a Pix charge on a boleto.

## Scope

Does not handle accounting, payroll, or card acquiring. Use for registering and managing Banco do Brasil collection boletos and their Pix charges only.

## Capabilities

- Register a collection boleto in Banco do Brasil from a billing document
- List and filter the boletos issued under an agreement
- Retrieve the full detail of a single boleto by its id
- Amend a registered boleto when its due date or amount changes
- Run the operational write-off or cancellation flow for a boleto
- Generate or cancel a Pix charge attached to a boleto
- Query the operational settlement status of registered boletos

## Use cases

### Agent-driven boleto billing

An AI agent issues Banco do Brasil boletos as invoices are raised and keeps their status current. It registers each boleto from the billing document, amends due dates when terms change, and runs the write-off flow when a slip is paid or cancelled, so collections stay in step with the ledger without a human re-keying each slip.

Example prompt: Register a boleto for a 500.00 BRL invoice, then poll its detail until the operational write-off shows it settled

### Boleto plus Pix payment option

Brazilian payers increasingly prefer paying a boleto by Pix instant transfer. The API generates a Pix charge on an existing boleto and can cancel it, letting a checkout offer both the printed slip and an instant Pix option for the same debt, with the Pix state queryable per boleto.

Example prompt: Generate a Pix charge for an open boleto and return its Pix detail so the payer can scan and pay

### Collection settlement reconciliation

Finance needs to know which issued boletos have actually been paid. The operational baixa flow reports settlement against a billing agreement, so an agent can reconcile paid versus outstanding boletos and flag overdue slips for follow-up, driven by the authoritative bank data rather than a manual bank statement check.

Example prompt: List settled boletos through the operational write-off query and mark the matching invoices as paid

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/boletos` | Register a collection boleto |
| GET | `/boletos` | List boletos |
| GET | `/boletos/{id}` | Get a single boleto's detail |
| PATCH | `/boletos/{id}` | Amend a registered boleto |
| POST | `/boletos/{id}/baixar` | Write off or cancel a boleto |
| POST | `/boletos/{id}/gerar-pix` | Generate a Pix charge on a boleto |
| POST | `/boletos/{id}/cancelar-pix` | Cancel a boleto's Pix charge |
| GET | `/boletos/{id}/pix` | Query a boleto's Pix charge |

## Key resources

- **Boletos** — Register, list, detail, amend, and write off collection boletos
- **Pix on boleto** — Generate, cancel, and query a Pix charge attached to a boleto
- **Agreement settlement** — Operational write-off (baixa) status tied to a billing agreement

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 68 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 68 / 100
  - Developer Experience & Jentic Compatibility: 73 / 100
  - AI-Readiness & Agent Experience: 52 / 100
  - Agent Usability: 94 / 100
  - Security: 74 / 100
  - AI Discoverability: 70 / 100
- **View full report:** https://jentic.com/apis/bb.com.br/main/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring the Cobranças API by hand means standing up OAuth2 client credentials, an application key, and a mutual-TLS certificate, then picking the production versus homologation host. Through Jentic you install once, import it from the API Directory, store the credentials once, and your agent calls it.
- **Permission scoping:** Boleto targets travel in the request body and the id in the URL path, so a rule bounds which operations your agent may call, such as register and list, rather than a single slip. You choose the operations it may call, so write-off and cancellation are not included unless you add them.
- **Credential handling:** Your Banco do Brasil credentials are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'register a boleto' or 'generate a Pix charge', and Jentic returns the matching operation with its input schema so the agent calls the right endpoint without reading the reference docs.

## Related APIs

- **GoCardless** — GoCardless collects payments by bank debit rather than Brazilian boletos and Pix.
- **Stripe** — Stripe processes cards and wallets globally, where Banco do Brasil Cobranças issues local boletos.
- **Recurly** — Recurly runs the subscription billing that a boleto or Pix charge can then collect against.

## FAQ

### What authentication does the Cobranças API use?

The Cobranças API authenticates with OAuth2 client-credentials tokens together with an application key and mutual TLS, as declared in its OpenAPI spec. Through Jentic those credentials are stored encrypted by your own Jentic One instance and injected when a call runs, so they never reach the agent's prompt or logs.

### Can I offer Pix payment on a boleto with this API?

Yes. The API generates a Pix charge on an existing boleto, lets you cancel it, and returns the Pix detail for a boleto, so a payer can settle the same slip by instant Pix transfer.

### What are the rate limits for the Cobranças API?

The OpenAPI spec does not state rate limits. Banco do Brasil publishes limits per environment on its developer portal at bb.com.br, so check there before scheduling bulk boleto registration.

### Is there a Cobranças API MCP server?

You do not need an MCP server to give your agent the Cobranças API. Jentic connects it directly from the API Directory: import it, store your Banco do Brasil credentials once, and your agent registers and queries boletos on demand.

### Can I limit what my agent is allowed to do with the Cobranças API?

Yes. Write a rule that allows only the boleto register and list operations, so the agent can issue and read collection slips but cannot write off, cancel Pix, or amend amounts, and every call it makes is logged.

### How do I register a boleto with this API through Jentic?

Search Jentic for an intent like 'register a collection boleto' and it returns the matching operation with its input schema, then your agent calls it with the Banco do Brasil credentials Jentic injects at runtime. To run it on your own infrastructure, install Jentic One from its GitHub repo.