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) Recurring Pix API

The Recurring Pix API from Efí Pay (Gerencianet) — 11 operation(s) for recurring pix.

Efí Pay (Gerencianet) Recurring 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 Recurring Pix. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and 5 JSON Schemas.

This API exposes 16 operations across 11 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.

16 operations 11 paths 0 schemas 1 DELETE6 GET4 PATCH5 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) Recurring 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 16

Across 11 paths, the API surfaces 16 operations — 1 DELETE, 6 GET, 4 PATCH, 5 POST. Each is listed below with its method, path, parameters, and response codes.

Recurring Pix 16
POST
/pagamentos-recorrentes/pix
Start Recurring Pix
ofStartRecurrencyPixPayment → 201
GET
/pagamentos-recorrentes/pix
List Recurring Pix
ofListRecurrencyPixPayment → 200
PATCH
/pagamentos-recorrentes/pix/{identificadorPagamento}/cancelar
Cancel Recurring Pix
ofCancelRecurrencyPix 1 param → 200
POST
/pagamentos-recorrentes/pix/{identificadorPagamento}/devolver
Refund Recurring Pix
ofDevolutionRecurrencyPix 1 param → 201
PATCH
/pagamentos-recorrentes/pix/{identificadorPagamento}/substituir/{endToEndId}
Replace Recurring Pix Parcel
ofReplaceRecurrencyPixParcel 2 params → 200
POST
/v2/rec
Create Recurring Pix
pixCreateRecurrenceAutomatic → 201
GET
/v2/rec
List Recurring Pix
pixListRecurrenceAutomatic → 200
GET
/v2/rec/{idRec}
Detail Recurring Pix
pixDetailRecurrenceAutomatic 1 param → 200
PATCH
/v2/rec/{idRec}
Update Recurring Pix
pixUpdateRecurrenceAutomatic 1 param → 200
POST
/v2/solicrec
Create Recurring Pix Request
pixCreateRequestRecurrenceAutomatic → 201
GET
/v2/solicrec/{idSolicRec}
Detail Recurring Pix Request
pixDetailRequestRecurrenceAutomatic 1 param → 200
PATCH
/v2/solicrec/{idSolicRec}
Update Recurring Pix Request
pixUpdateRequestRecurrenceAutomatic 1 param → 200
POST
/v2/locrec
Create Recurring Pix Location
pixCreateLocationRecurrenceAutomatic → 201
GET
/v2/locrec
List Recurring Pix Locations
pixListLocationRecurrenceAutomatic → 200
GET
/v2/locrec/{id}
Detail Recurring Pix Location
pixDetailLocationRecurrenceAutomatic 1 param → 200
DELETE
/v2/locrec/{id}/idRec
Unlink Recurring Pix Location
pixUnlinkLocationRecurrenceAutomatic 1 param → 204

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

gerencianet-recurring-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