Efí Pay (Gerencianet)

Efí Pay (Gerencianet) Recurring Pix API

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

GitHub OpenAPI

Operations 16

POST /pagamentos-recorrentes/pix Start Recurring Pix #
GET /pagamentos-recorrentes/pix List Recurring Pix #
PATCH /pagamentos-recorrentes/pix/{identificadorPagamento}/cancelar Cancel Recurring Pix #
POST /pagamentos-recorrentes/pix/{identificadorPagamento}/devolver Refund Recurring Pix #
PATCH /pagamentos-recorrentes/pix/{identificadorPagamento}/substituir/{endToEndId} Replace Recurring Pix Parcel #
POST /v2/rec Create Recurring Pix #
GET /v2/rec List Recurring Pix #
GET /v2/rec/{idRec} Detail Recurring Pix #
PATCH /v2/rec/{idRec} Update Recurring Pix #
POST /v2/solicrec Create Recurring Pix Request #
GET /v2/solicrec/{idSolicRec} Detail Recurring Pix Request #
PATCH /v2/solicrec/{idSolicRec} Update Recurring Pix Request #
POST /v2/locrec Create Recurring Pix Location #
GET /v2/locrec List Recurring Pix Locations #
GET /v2/locrec/{id} Detail Recurring Pix Location #
DELETE /v2/locrec/{id}/idRec Unlink Recurring Pix Location #

Documentation

📖
Documentation
https://dev.efipay.com.br/docs/api-cobrancas/credenciais
📖
APIReference
https://dev.efipay.com.br
📖
Documentation
https://dev.efipay.com.br/docs/api-pix/credenciais
📖
APIReference
https://dev.efipay.com.br/docs/api-pix
📖
Documentation
https://dev.efipay.com.br/docs/open-finance
📖
Documentation
https://dev.efipay.com.br/docs/abertura-de-contas
📖
Documentation
https://dev.efipay.com.br/docs/api-pagamentos
📖
Documentation
https://dev.efipay.com.br/docs/extrato-cnab

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/gerencianet/refs/heads/main/openapi/gerencianet-recurring-pix-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/gerencianet/refs/heads/main/json-schema/efi-cobrancas-charge-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/gerencianet/refs/heads/main/json-structure/efi-cobrancas-charge-structure.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/gerencianet/refs/heads/main/json-schema/efi-pix-cob-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/gerencianet/refs/heads/main/json-schema/efi-pix-pix-received-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/gerencianet/refs/heads/main/json-structure/efi-pix-cob-structure.json

Other Resources

🔗
BaseURL
https://cobrancas.api.efipay.com.br/v1
🔗
SandboxURL
https://cobrancas-h.api.efipay.com.br/v1
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/gerencianet/refs/heads/main/examples/efi-cobrancas-onestep-example.json
🔗
BaseURL
https://pix.api.efipay.com.br
🔗
SandboxURL
https://pix-h.api.efipay.com.br
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/gerencianet/refs/heads/main/examples/efi-pix-create-cob-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/gerencianet/refs/heads/main/examples/efi-pix-send-example.json
🔗
BaseURL
https://openfinance.api.efipay.com.br/v1
🔗
SandboxURL
https://openfinance-h.api.efipay.com.br/v1
🔗
BaseURL
https://abrircontas.api.efipay.com.br/v1
🔗
SandboxURL
https://abrircontas-h.api.efipay.com.br/v1
🔗
BaseURL
https://pagarcontas.api.efipay.com.br/v1
🔗
SandboxURL
https://pagarcontas-h.api.efipay.com.br/v1
🔗
BaseURL
https://extratos.api.efipay.com.br/v1
🔗
SandboxURL
https://extratos-h.api.efipay.com.br/v1

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/gerencianet-recurring-pix-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

gerencianet-recurring-pix-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Gerencianet Recurring Pix API
  license:
    name: Proprietary
  version: '1.0'
  description: 'Operations tagged Recurring Pix across 2 of this provider''s published API definitions: efi-openfinance-openapi.yml, efi-pix-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://openfinance.api.efipay.com.br/v1
  description: Production
- url: https://openfinance-h.api.efipay.com.br/v1
  description: Homologation (Sandbox)
- url: https://pix.api.efipay.com.br
  description: Production
- url: https://pix-h.api.efipay.com.br
  description: Homologation (Sandbox)
tags:
- name: Recurring Pix
paths:
  /pagamentos-recorrentes/pix:
    post:
      tags:
      - Recurring Pix
      summary: Start Recurring Pix
      operationId: ofStartRecurrencyPixPayment
      responses:
        '201':
          description: Started
      security:
      - oauth2OpenFinance: []
    get:
      tags:
      - Recurring Pix
      summary: List Recurring Pix
      operationId: ofListRecurrencyPixPayment
      responses:
        '200':
          description: Recurring Pix
      security:
      - oauth2OpenFinance: []
    servers:
    - url: https://openfinance.api.efipay.com.br/v1
      description: Production
    - url: https://openfinance-h.api.efipay.com.br/v1
      description: Homologation (Sandbox)
  /pagamentos-recorrentes/pix/{identificadorPagamento}/cancelar:
    patch:
      tags:
      - Recurring Pix
      summary: Cancel Recurring Pix
      operationId: ofCancelRecurrencyPix
      parameters:
      - name: identificadorPagamento
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Cancelled
      security:
      - oauth2OpenFinance: []
    servers:
    - url: https://openfinance.api.efipay.com.br/v1
      description: Production
    - url: https://openfinance-h.api.efipay.com.br/v1
      description: Homologation (Sandbox)
  /pagamentos-recorrentes/pix/{identificadorPagamento}/devolver:
    post:
      tags:
      - Recurring Pix
      summary: Refund Recurring Pix
      operationId: ofDevolutionRecurrencyPix
      parameters:
      - name: identificadorPagamento
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Refunded
      security:
      - oauth2OpenFinance: []
    servers:
    - url: https://openfinance.api.efipay.com.br/v1
      description: Production
    - url: https://openfinance-h.api.efipay.com.br/v1
      description: Homologation (Sandbox)
  /pagamentos-recorrentes/pix/{identificadorPagamento}/substituir/{endToEndId}:
    patch:
      tags:
      - Recurring Pix
      summary: Replace Recurring Pix Parcel
      operationId: ofReplaceRecurrencyPixParcel
      parameters:
      - name: identificadorPagamento
        in: path
        required: true
        schema:
          type: string
      - name: endToEndId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Replaced
      security:
      - oauth2OpenFinance: []
    servers:
    - url: https://openfinance.api.efipay.com.br/v1
      description: Production
    - url: https://openfinance-h.api.efipay.com.br/v1
      description: Homologation (Sandbox)
  /v2/rec:
    post:
      tags:
      - Recurring Pix
      summary: Create Recurring Pix
      operationId: pixCreateRecurrenceAutomatic
      responses:
        '201':
          description: Created
      security:
      - oauth2Pix: []
    get:
      tags:
      - Recurring Pix
      summary: List Recurring Pix
      operationId: pixListRecurrenceAutomatic
      responses:
        '200':
          description: Recurrences
      security:
      - oauth2Pix: []
    servers:
    - url: https://pix.api.efipay.com.br
      description: Production
    - url: https://pix-h.api.efipay.com.br
      description: Homologation (Sandbox)
  /v2/rec/{idRec}:
    get:
      tags:
      - Recurring Pix
      summary: Detail Recurring Pix
      operationId: pixDetailRecurrenceAutomatic
      parameters:
      - name: idRec
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Recurrence
      security:
      - oauth2Pix: []
    patch:
      tags:
      - Recurring Pix
      summary: Update Recurring Pix
      operationId: pixUpdateRecurrenceAutomatic
      parameters:
      - name: idRec
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Updated
      security:
      - oauth2Pix: []
    servers:
    - url: https://pix.api.efipay.com.br
      description: Production
    - url: https://pix-h.api.efipay.com.br
      description: Homologation (Sandbox)
  /v2/solicrec:
    post:
      tags:
      - Recurring Pix
      summary: Create Recurring Pix Request
      operationId: pixCreateRequestRecurrenceAutomatic
      responses:
        '201':
          description: Created
      security:
      - oauth2Pix: []
    servers:
    - url: https://pix.api.efipay.com.br
      description: Production
    - url: https://pix-h.api.efipay.com.br
      description: Homologation (Sandbox)
  /v2/solicrec/{idSolicRec}:
    get:
      tags:
      - Recurring Pix
      summary: Detail Recurring Pix Request
      operationId: pixDetailRequestRecurrenceAutomatic
      parameters:
      - name: idSolicRec
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Request
      security:
      - oauth2Pix: []
    patch:
      tags:
      - Recurring Pix
      summary: Update Recurring Pix Request
      operationId: pixUpdateRequestRecurrenceAutomatic
      parameters:
      - name: idSolicRec
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Updated
      security:
      - oauth2Pix: []
    servers:
    - url: https://pix.api.efipay.com.br
      description: Production
    - url: https://pix-h.api.efipay.com.br
      description: Homologation (Sandbox)
  /v2/locrec:
    post:
      tags:
      - Recurring Pix
      summary: Create Recurring Pix Location
      operationId: pixCreateLocationRecurrenceAutomatic
      responses:
        '201':
          description: Created
      security:
      - oauth2Pix: []
    get:
      tags:
      - Recurring Pix
      summary: List Recurring Pix Locations
      operationId: pixListLocationRecurrenceAutomatic
      responses:
        '200':
          description: Locations
      security:
      - oauth2Pix: []
    servers:
    - url: https://pix.api.efipay.com.br
      description: Production
    - url: https://pix-h.api.efipay.com.br
      description: Homologation (Sandbox)
  /v2/locrec/{id}:
    get:
      tags:
      - Recurring Pix
      summary: Detail Recurring Pix Location
      operationId: pixDetailLocationRecurrenceAutomatic
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Location
      security:
      - oauth2Pix: []
    servers:
    - url: https://pix.api.efipay.com.br
      description: Production
    - url: https://pix-h.api.efipay.com.br
      description: Homologation (Sandbox)
  /v2/locrec/{id}/idRec:
    delete:
      tags:
      - Recurring Pix
      summary: Unlink Recurring Pix Location
      operationId: pixUnlinkLocationRecurrenceAutomatic
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
      responses:
        '204':
          description: Unlinked
      security:
      - oauth2Pix: []
    servers:
    - url: https://pix.api.efipay.com.br
      description: Production
    - url: https://pix-h.api.efipay.com.br
      description: Homologation (Sandbox)
components:
  securitySchemes:
    oauth2OpenFinance:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://openfinance.api.efipay.com.br/v1/oauth/token
          scopes:
            openfinance.payments.read: Read payment status
            openfinance.payments.write: Initiate payments
    oauth2Pix:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://pix.api.efipay.com.br/oauth/token
          scopes:
            cob.read: Read immediate charges
            cob.write: Create/update immediate charges
            cobv.read: Read due charges
            cobv.write: Create/update due charges
            pix.read: Read received Pix
            pix.write: Manage devolutions
            pix.send: Send Pix
            webhook.read: Read webhook config
            webhook.write: Configure webhooks
            gn.balance.read: Read account balance
x-refined-from:
- efi-openfinance-openapi.yml
- efi-pix-openapi.yml