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

Efí Pix Payments API

Received Pix, sent Pix, and refunds. Host pix.api.efipay.com.br, mTLS required.

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

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

This API exposes 4 operations across 3 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.

4 operations 3 paths 5 schemas 3 GET1 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
Resource Areas
1

Authentication & Security 1

Efí Pix Payments 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 4

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

Pix Payments 4

Received Pix, sent Pix, and refunds. Host pix.api.efipay.com.br, mTLS required.

GET
/v2/pix
List received Pix
listReceivedPix 2 params → 200401
GET
/v2/pix/{e2eid}
Retrieve a received Pix
getReceivedPix 1 param → 200401404
PUT
/v2/pix/{e2eid}/devolucao/{id}
Request a Pix refund (devolução)
requestRefund 2 params body → 201401
GET
/v2/pix/{e2eid}/devolucao/{id}
Retrieve a Pix refund
getRefund 2 params → 200401404

Schemas 5

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

Error
object
4 properties
Pix
object
5 properties
RefundRequest
object
1 property
PixList
object
1 property
Refund

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

efi-bank-pix-payments-api-openapi.yml Raw ↑

Other APIs Efí publishes across the network.

Efí Authorization API
Efí Carnê API
Efí Cobranças API
Efí Open Finance API
Efí Pix Charges API
Efí Pix Webhooks API
Where this information came from

This is an independent, third-party profile of Efí Pix Payments 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.