Efí Carnê API
Installment booklets. Host cobrancas.api.efipay.com.br, no mTLS.
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.0.3, 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.
Metadata
The identity and technical contract details declared by the specification.
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.
Installment booklets. Host cobrancas.api.efipay.com.br, no mTLS.
Schemas 5
The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Error (4 properties), CarnetRequest (4 properties), Carnet (3 properties), CarnetParcel (3 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Efí 6
Other APIs Efí publishes across the network.