Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Efí Authorization API

OAuth2 client-credentials token endpoints (per host).

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

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

This API exposes 3 operations across 3 paths, and defines 3 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.

3 operations 3 paths 3 schemas 3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://pix.api.efipay.com.br
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Efí Authorization 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 3

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

Authorization 3

OAuth2 client-credentials token endpoints (per host).

POST
/oauth/token
Obtain a Pix API access token
pixAuthorize body → 200401
POST
/v1/authorize
Obtain a Cobranças API access token
cobrancasAuthorize body → 200401
POST
/v1/oauth/token
Obtain an Open Finance API access token
openFinanceAuthorize body → 200401

Schemas 3

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

TokenRequest
object
1 property
TokenResponse
object
4 properties
Error
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Efí publishes across the network.

Efí Carnê API
Efí Cobranças API
Efí Open Finance API
Efí Pix Charges API
Efí Pix Payments API
Efí Pix Webhooks API