Install Jentic One Beta

Connect the Cobranças API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Cobranças 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%2Fbb.com.br%2Fmain" | 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%2Fbb.com.br%2Fmain" | 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 Cobranças API.

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

GET STARTED

Start building with Cobranças API

Explore with Jentic One

View OpenAPI Document

Use Cases

Patterns agents use Cobranças API for, with concrete tasks.

★ 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.

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.

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.

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

Key Endpoints

12 endpoints — the cobranças api registers and manages banco do brasil collection boletos, the bank slips brazilian businesses issue to get paid.

METHOD

PATH

DESCRIPTION

POST

/boletos

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

POST

/boletos

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

Why Jentic?

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

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 isolation

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.

Intent-based discovery

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.

FAQs

Specific to using Cobranças API through Jentic.

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.

Bb Cobranças API

AI ReadinessAI-Aware (B+)68/100

See full scorecard

Community OpenAPI document · agent-readyPaymentsPayment Processingoauth2, apiKey, mutualTLS12 EndpointsREST

Know of an official OpenAPI document? Contribute it →

For 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.

Use for: Register a collection boleto for a customer invoice, List the boletos issued under my agreement, Get the full detail of a boleto by its id, Change the due date on an existing boleto

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

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.

Jentic One on Github View OpenAPI Document

Show dimension breakdown

Foundational Compliance

Base layer of spec validity and structural soundness.

Grade: B+Signals: 4

96%

Lint Results

Aggregated quality score from linter diagnostics, weighted by severity.

100%

Resolution Completeness

Percentage of `$ref` references that resolve successfully.

Specification Validity

Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).

75%

Structural Integrity

Structural correctness score based on schema issues using logarithmic dampening.

Developer Experience & Jentic Compatibility

Clarity, completeness, and ingestion readiness for developers and tooling.

Grade: A-Signals: 4

18%

Example Density

How richly the API is illustrated with examples.

98%

Example Validity

Percentage of examples that conform to their schemas.

75%

Response Coverage

Percentage of operations with complete response definitions (success, client error, server error).

100%

Tooling Readiness

Health of API ingestion, bundling, and resolution within Jentic pipelines.

AI-Readiness & Agent Experience

Semantic breadth, depth, and agent comprehension for AI systems.

Grade: C-Signals: 4

86%

Description Coverage

Coverage of descriptions across API elements.

Error Standardization

Coverage of RFC 9457 Problem Details for error responses.

75%

OperationId Quality

Coverage, uniqueness, and casing consistency of operationIds for AI inference.

46%

Summary Coverage

Coverage of summaries across operations/tags/info.

Agent Usability

Functional utility, complexity comfort, and AI orchestration readiness.

Grade: A+Signals: 1

94%

Complexity Comfort

Agent comfort level based on API operational and structural complexity.

Security

Trust, risk posture, and security compliance.

Grade: A-Signals: 1

74%

Authentication Strength

Average quality of security schemes based on authentication method strength (weakest link for OAuth2).

AI Discoverability

Findability, semantic richness, and reasoning readiness.

Grade: B+Signals: 1

70%

Descriptive Richness

Clarity and depth of descriptions across API elements.

Connect the Cobranças API to your agent

Capabilities

Start building with Cobranças API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs

Bb Cobranças API

Jentic AI Readiness Score

Cobranças API

Foundational Compliance

Lint Results

Resolution Completeness

Specification Validity

Structural Integrity

Developer Experience & Jentic Compatibility

Example Density

Example Validity

Response Coverage

Tooling Readiness

AI-Readiness & Agent Experience

Description Coverage

Error Standardization

OperationId Quality

Summary Coverage

Agent Usability

Complexity Comfort

Security

Authentication Strength

AI Discoverability

Descriptive Richness