How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Efí

Efí Carnê API

Installment booklets. Host cobrancas.api.efipay.com.br, no mTLS.

Documentation Provider Profile APIs.io OpenAPI GitHub

Efí Carnê API is one of 7 APIs that Efí publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Carnê. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 5 operations across 5 paths, and defines 5 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 4 base URLs: https://pix.api.efipay.com.br, https://pix-h.api.efipay.com.br, https://cobrancas.api.efipay.com.br, https://openfinance.api.efipay.com.br.

5 operations 5 paths 5 schemas 1 GET1 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://pix.api.efipay.com.br
Authentication
OAuth 2.0
Contact
Efí Developers
Resource Areas
1

Authentication & Security 1

Efí Carnê API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oAuth2ClientCredentials) using the clientCredentials flow, exposing 13 scopes. By default, every request must be authenticated.

  • oAuth2ClientCredentials — OAuth2 client-credentials. Obtain a bearer token from the host's token endpoint using HTTP Basic auth (ClientId / ClientSecret), then send it as Authorization:…

Paths & Operations 5

Across 5 paths, the API surfaces 5 operations — 1 GET, 1 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Carnê 5

Installment booklets. Host cobrancas.api.efipay.com.br, no mTLS.

POST
/v1/carnet
Create a carnê
createCarnet body → 200401
GET
/v1/carnet/{id}
Retrieve a carnê
getCarnet 1 param → 200401404
PUT
/v1/carnet/{id}/parcel/{parcel}
Change a parcel's due date
updateCarnetParcelDueDate 2 params body → 200401
PUT
/v1/carnet/{id}/cancel
Cancel a carnê
cancelCarnet 1 param → 200401
PUT
/v1/carnet/{id}/settle
Manually settle a carnê
settleCarnet 1 param → 200401

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are CarnetRequest (4 properties), Error (4 properties), CarnetParcel (3 properties), Carnet (3 properties). Each schema is shown below with its type and property counts.

Error
object
4 properties
ChargeItem
object
3 properties
Carnet
object
3 properties
CarnetRequest
object
4 properties
CarnetParcel
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

efi-bank-carn-api-openapi.yml Raw ↑

Other APIs Efí publishes across the network.

Efí Authorization API
AE Profile APIs.io
Efí Cobranças API
AE Profile APIs.io
Efí Open Finance API
AE Profile APIs.io
Efí Pix Charges API
AE Profile APIs.io
Efí Pix Payments API
AE Profile APIs.io
Efí Pix Webhooks API
AE Profile APIs.io
#Carnê
← Back to E APIs
API Details
ID
efi-bank:efi-bank-carn-api
Base URL
https://pix.api.efipay.com.br
Docs
https://dev.efipay.com.br/docs/api-pix/cobrancas-imediatas
Provider
Efí
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=efi-bank-carn-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/efi-bank-carn-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Efí Carnê API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.