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í Pay (Gerencianet) Immediate Pix API

The Immediate Pix API from Efí Pay (Gerencianet) — 2 operation(s) for immediate pix.

Efí Pay (Gerencianet) Immediate Pix API is one of 36 APIs that Efí Pay (Gerencianet) publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 5 JSON Schema definitions.

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

This API exposes 3 operations across 2 paths. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against 2 base URLs: https://cobrancas.api.efipay.com.br/v1, https://cobrancas-h.api.efipay.com.br/v1.

3 operations 2 paths 0 schemas 1 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Servers
https://cobrancas.api.efipay.com.br/v1
https://cobrancas-h.api.efipay.com.br/v1
Authentication
OAuth 2.0
License
Proprietary
Resource Areas
1

Authentication & Security 1

Efí Pay (Gerencianet) Immediate Pix API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2ClientCredentials) using the clientCredentials flow. By default, every request must be authenticated.

Paths & Operations 3

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

Immediate Pix 3
POST
/pagamentos/pix
Start Pix Payment
ofStartPixPayment → 201
GET
/pagamentos/pix
List Pix Payments
ofListPixPayment → 200
POST
/pagamentos/pix/{identificadorPagamento}/devolver
Refund Pix Payment
ofDevolutionPix 1 param → 201

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

gerencianet-immediate-pix-api-openapi.yml Raw ↑

Other APIs Efí Pay (Gerencianet) publishes across the network.

Efí Pay (Gerencianet) Account API
Efí Pay (Gerencianet) Accounts API
Efí Pay (Gerencianet) Authorization API
Efí Pay (Gerencianet) Automatic Charges API
Efí Pay (Gerencianet) Automatic Pix API
Efí Pay (Gerencianet) Bill Payments API
Efí Pay (Gerencianet) Biometric Pix API
Efí Pay (Gerencianet) Card Payments API
Efí Pay (Gerencianet) Carnets API
Efí Pay (Gerencianet) Charges API
Efí Pay (Gerencianet) Configuration API
Efí Pay (Gerencianet) Devolutions API