Efí Pay (Gerencianet) Recurring Pix API

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

Documentation GitHub OpenAPI

Business capability

Payment Initiation Management BC-1340.10

Operations 16

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /pagamentos-recorrentes/pix Start an Open Finance recurring Pix payment · Start Recurring Pix #

Ask an LLM

“How do I set up a repeating Pix payment through Open Finance?”

“Can I initiate a series of recurring payments from the payer's bank?”

Tell an agent

Start an Open Finance recurring Pix payment.

Initiate a repeating payment series via Open Finance.

GET /pagamentos-recorrentes/pix List Open Finance recurring Pix payments · List Recurring Pix #

Ask an LLM

“Which recurring Pix payments have I set up through Open Finance?”

“Can I see my Open Finance recurring payment series?”

Tell an agent

List my Open Finance recurring Pix payments.

Show recurring payments I initiated via Open Finance.

PATCH /pagamentos-recorrentes/pix/{identificadorPagamento}/cancelar Cancel an Open Finance recurring Pix payment · Cancel Recurring Pix #

Ask an LLM

“Can I cancel a recurring Pix series I started through Open Finance?”

“What stops future installments of an Open Finance recurring payment?”

Tell an agent destructive · confirm first

Cancel Open Finance recurring payment {identificadorPagamento}.

Stop recurring Pix series {identificadorPagamento}.

POST /pagamentos-recorrentes/pix/{identificadorPagamento}/devolver Refund an Open Finance recurring Pix payment · Refund Recurring Pix #

Ask an LLM

“Can I refund a payment from an Open Finance recurring series?”

“What returns money on a recurring Pix I collected via Open Finance?”

Tell an agent

Refund recurring payment {identificadorPagamento}.

Return the money on Open Finance recurring series {identificadorPagamento}.

PATCH /pagamentos-recorrentes/pix/{identificadorPagamento}/substituir/{endToEndId} Replace one installment of a recurring Pix · Replace Recurring Pix Parcel #

Ask an LLM

“Can I replace a single installment within an Open Finance recurring payment?”

“What swaps out one parcel of a recurring Pix series?”

Tell an agent

Replace parcel {endToEndId} of recurring payment {identificadorPagamento}.

Swap installment {endToEndId} in recurring series {identificadorPagamento}.

POST /v2/rec Create a Pix Automático recurrence · Create Recurring Pix #

Ask an LLM

“How do I register a new Pix Automático recurrence for a customer?”

“Can I create a rec before sending the payer an authorization request?”

Tell an agent

Create a Pix Automático recurrence.

Register a new automatic Pix recurrence for a customer.

GET /v2/rec List Pix Automático recurrences · List Recurring Pix #

Ask an LLM

“Which Pix Automático recurrences have I registered as a biller?”

“Can I see all my rec authorizations?”

Tell an agent

List my Pix Automático recurrences.

Show all recurrence authorizations I've created as a biller.

GET /v2/rec/{idRec} Get a Pix Automático recurrence · Detail Recurring Pix #

Ask an LLM

“Can I check whether a payer has authorized a Pix Automático recurrence?”

“What status is a given rec in?”

Tell an agent

Show Pix Automático recurrence {idRec}.

Get the status of recurrence {idRec}.

PATCH /v2/rec/{idRec} Update a Pix Automático recurrence · Update Recurring Pix #

Ask an LLM

“Can I change a Pix Automático recurrence after it was created?”

“What edits an existing rec?”

Tell an agent

Update Pix Automático recurrence {idRec}.

Edit recurrence {idRec}.

POST /v2/solicrec Ask a payer to authorize a recurrence · Create Recurring Pix Request #

Ask an LLM

“How do I send a payer a request to approve Pix Automático?”

“Can I create a solicrec for an existing recurrence?”

Tell an agent

Create a recurrence authorization request.

Send the payer a request to approve their Pix Automático recurrence.

GET /v2/solicrec/{idSolicRec} Get a recurrence authorization request · Detail Recurring Pix Request #

Ask an LLM

“Has the payer answered my Pix Automático authorization request?”

“Can I look up a solicrec by id?”

Tell an agent

Show recurrence request {idSolicRec}.

Get the status of authorization request {idSolicRec}.

PATCH /v2/solicrec/{idSolicRec} Update a recurrence authorization request · Update Recurring Pix Request #

Ask an LLM

“Can I change or withdraw a Pix Automático authorization request I sent?”

“What edits an existing solicrec?”

Tell an agent

Update recurrence request {idSolicRec}.

Change authorization request {idSolicRec}.

POST /v2/locrec Create a Pix Automático recurrence location · Create Recurring Pix Location #

Ask an LLM

“How do I create a location for a Pix Automático recurrence QR code?”

“Can I reserve a locrec before creating the recurrence?”

Tell an agent

Create a recurrence location.

Reserve a new locrec for a Pix Automático recurrence.

GET /v2/locrec List Pix Automático recurrence locations · List Recurring Pix Locations #

Ask an LLM

“Which locations have I created for Pix Automático recurrences?”

“Can I see all my locrec entries?”

Tell an agent

List my recurrence locations.

Show all locrec entries on my account.

GET /v2/locrec/{id} Get a Pix Automático recurrence location · Detail Recurring Pix Location #

Ask an LLM

“Can I see which recurrence a locrec is linked to?”

“What does a recurrence location contain?”

Tell an agent

Show recurrence location {id}.

Get the details of locrec {id}.

DELETE /v2/locrec/{id}/idRec Detach a recurrence from its location · Unlink Recurring Pix Location #

Ask an LLM

“Can I unlink a Pix Automático recurrence from its locrec?”

“What frees a recurrence location for reuse?”

Tell an agent destructive · confirm first

Unlink the recurrence from location {id}.

Detach the idRec bound to locrec {id}.

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: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

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

Efí Pay (Gerencianet) Recurring Pix API

Operations 16

Documentation

Specifications

Schemas & Data

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification