Skip to content
BranchesTags

Repository files navigation

Efí (efi-bank)

About this repository

This is not our API. This repository is an independent, third-party profile of a company's publicly available API surface, maintained by API Evangelist. API Evangelist does not operate, host, resell, or support this company's APIs, and is not affiliated with or endorsed by the company unless stated on the profile.

Where the information came from. Everything here is assembled from material a member of the public can reach with a browser and no credentials — the company's own website, developer portal and documentation, the specifications it publishes for public use (OpenAPI, AsyncAPI, JSON Schema, apis.json, llms.txt and similar), its public repositories, and its public status, pricing and changelog pages. Nothing here is obtained by breaching a system, defeating an access control, or using credentials of any kind.

The rating is an independent assessment. The Kin Score and Agent Readiness rating are independently calculated scores of a company's public API artifacts, produced by API Evangelist against a published rubric. They are not certifications, endorsements, security assessments, or audits, and they score published artifacts — not the quality, safety, or security of the software.

Corrections, re-scores, and removal are free. No partnership, contract, or purchase is required, and you do not need to justify the request.

  • Something wrong? Open an issue on this repository, or email info@apievangelist.com.
  • Published something new? Ask for a re-score and we will re-run the rating.
  • Want the listing taken down? Say so and we will honor it. The profile is reduced to your company name, a factual description, and a link to your own site, and the company is recorded as unrated — never scored zero for having asked.

Response times. Acknowledgement within one business day; removal or restriction within two business days; corrections and re-scores within five business days.

Not from the company, and here with a question? You are welcome here — we would rather be the front line and point you the right way than have a good report go nowhere. What this repository can answer is narrow, though, so it is worth knowing who you are actually looking for:

  • A question about how the API works, an account, billing, or a bug in the service — that is the company's own support, not us. We profile this API; we do not operate it and cannot see your account.
  • A bug in an open-source project we only catalog — file it on that project's own repository. This has happened with a real and correct bug report that reached us instead of the people who could fix it, which helped nobody.
  • Anything about this listing itself — the description, the tags, the rating, a missing or wrong artifact — is ours. Open an issue here.
  • Not sure, or something general about API Evangelist or APIs.io — open an issue on the APIs.io Inbox and we will route it.

This repository contains no software, and we will never ask you to download anything. There is no build, release, installer, or binary here — only text and machine-readable API descriptions, so there is nothing here that can be "corrupt" or need "repairing". Any issue, comment, or email claiming otherwise and offering a download link is not from us and is hostile. Do not follow the link; it is a lure. Report it to GitHub and, if you like, tell us at info@apievangelist.com so we can take it down.

On a security or compliance team? Email info@apievangelist.com with 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 so your team can see the same surface we did, and we will take the listing down on request while you work through it.

Full detail: Where this data comes from

Efí (formerly Gerencianet) is a Brazilian payment institution ("Instituição de Pagamento", CNPJ 09.089.356/0001-18) and digital bank. It publishes a set of well-documented public REST APIs for the Brazilian financial system: Pix (immediate and dated charges, send/receive, refunds, webhooks), Boletos and Charges (Cobranças), Carnê installment booklets, and Pix via Open Finance. The company rebranded from Gerencianet to Efí; older SDKs, host names, and OAuth scope prefixes (e.g. gn.) still reflect the Gerencianet lineage.

APIs.json: https://raw.githubusercontent.com/api-evangelist/efi-bank/refs/heads/main/apis.yml

Access Model (Honest Summary)

Efí's APIs are live, public, and production-grade, but the auth model differs by product host:

  • Pix API — base https://pix.api.efipay.com.br (sandbox https://pix-h.api.efipay.com.br). Requires OAuth2 client-credentials (token at POST /oauth/token, HTTP Basic with Client_Id/Client_Secret) PLUS a mandatory mutual TLS (mTLS) client certificate (.p12/.pem) on every request — this is a Brazilian Central Bank (BACEN) requirement for the Pix arrangement, not an Efí choice.
  • Pix via Open Finance API — base https://openfinance.api.efipay.com.br (sandbox https://openfinance-h.api.efipay.com.br). Also requires OAuth2 client-credentials (token at POST /v1/oauth/token) PLUS mTLS.
  • Cobranças (Charges) API — base https://cobrancas.api.efipay.com.br (sandbox https://cobrancas-h.api.efipay.com.br). Uses OAuth2 client-credentials (token at POST /v1/authorize, HTTP Basic). No mTLS certificate required.

You obtain Client_Id / Client_Secret and generate the mTLS certificate inside the Efí account dashboard. SDKs are published for PHP, Node.js, Python, Java, Go, Ruby, Delphi, TypeScript, and Flutter, plus e-commerce modules (WooCommerce, WordPress, PrestaShop, Magento 2, OpenCart, WHMCS).

The create/query charge, webhook, Cobranças charge, and Carnê operations in this repository were confirmed directly against Efí's public documentation. The dated-charge (cobv), received-Pix (pix), refund (devolução), payload-location (loc), and Open Finance path operations are modeled on the BACEN Pix API v2 standard that Efí implements and on Efí's documented OAuth scopes; treat their exact paths as representative. See review.yml for the confirmed-vs-modeled breakdown.

Tags

  • Payments
  • Pix
  • Boleto
  • Banking
  • Brazil
  • Latin America
  • Charges
  • Digital Account
  • Financial Infrastructure
  • Fintech

Timestamps

  • Created: 2026-07-12
  • Modified: 2026-07-12

APIs

Efí Pix Charges API

Create and manage Pix charges — immediate charges (cob) and dated charges with due date (cobv) — plus payload locations (loc) that generate the dynamic QR Code and Pix Copia e Cola payload. Requires OAuth2 client-credentials and a mandatory mTLS certificate.

Tags

  • Pix
  • Charges
  • QR Code
  • Brazil

Properties

Efí Pix Payments API

Consult received Pix (Cash-In), send Pix directly from the API (Cash-Out), and request or query refunds (devolução) tied to an end-to-end identifier. Requires OAuth2 client-credentials and a mandatory mTLS certificate.

Tags

  • Pix
  • Payments
  • Refunds
  • Cash Out

Properties

Efí Pix Webhooks API

Register, retrieve, and cancel webhooks that notify your application about received Pix, keyed to a Pix key (chave). Server-to-endpoint HTTPS callbacks, not a WebSocket. Requires OAuth2 client-credentials and a mandatory mTLS certificate.

Tags

  • Pix
  • Webhooks
  • Notifications

Properties

Efí Cobranças (Charges) API

Issue and manage charges (transações) payable by boleto bancário, credit card, or Pix — one-step or two-step creation, due-date changes, manual settlement (baixa), cancellation, resend, and history. Uses OAuth2 client-credentials over HTTP Basic; no mTLS certificate required.

Tags

  • Boleto
  • Charges
  • Checkout
  • Brazil

Properties

Efí Carnê API

Generate and manage carnês — a batch of installment charges (parcelas) issued together as a booklet. Create a carnê, change parcel due dates, cancel or settle the whole booklet or individual parcels, and resend by email. Uses OAuth2 client-credentials; no mTLS certificate required.

Tags

  • Carnê
  • Installments
  • Boleto

Properties

Efí Pix via Open Finance API

Initiate Pix payments as a payment initiator across banks and fintechs connected to Brazil's Open Finance ecosystem, query participants, and consult or reverse initiated payments. Requires OAuth2 client-credentials and a mandatory mTLS certificate.

Tags

  • Open Finance
  • Pix
  • Payment Initiation

Properties

Common Properties

Maintainers

FN: Kin Lane Email: kin@apievangelist.com

About

Efí — independent third-party profile of a public API surface, by API Evangelist. Efí (formerly Gerencianet) is a Brazilian payment institution and digital bank that exposes well-documented public REST APIs for the Brazilian financial system - Pix (immediate and dated charges, send/receive, refunds, webhooks), Boletos and Charges (Cobranças), Carnê

Topics

apis-jsonbankingboletobrazilchargesdigital-accountfinancial-infrastructurefintechlatin-americapaymentspix

Resources

Readme
Activity
Custom properties

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

Packages

Contributors