Efí Pay (Gerencianet) Scheduled Pix API

The Scheduled Pix API from Efí Pay (Gerencianet) — 3 operation(s) for scheduled pix.

Business capability
Payment Initiation Management BC-1340.10

Operations 4

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-agendados/pix Schedule a Pix payment via Open Finance · Start Scheduled Pix #
Ask an LLM
“How do I schedule a Pix payment for a later date through Open Finance?”
“Can I initiate a future-dated Pix from the payer's bank?”
Tell an agent
Schedule an Open Finance Pix payment.
Start a future-dated Pix payment.
GET /pagamentos-agendados/pix List scheduled Open Finance Pix payments · List Scheduled Pix #
Ask an LLM
“Which future-dated Pix payments have I scheduled through Open Finance?”
“Can I see my scheduled Pix payments?”
Tell an agent
List my scheduled Pix payments.
Show Pix payments scheduled for a future date.
PATCH /pagamentos-agendados/pix/{identificadorPagamento}/cancelar Cancel a scheduled Pix payment · Cancel Scheduled Pix #
Ask an LLM
“Can I cancel a scheduled Pix before its date arrives?”
“What stops a future-dated Open Finance payment?”
Tell an agent destructive · confirm first
Cancel scheduled payment {identificadorPagamento}.
Stop scheduled Pix {identificadorPagamento}.
POST /pagamentos-agendados/pix/{identificadorPagamento}/devolver Refund a scheduled Pix payment · Refund Scheduled Pix #
Ask an LLM
“Can I refund a scheduled Pix payment after it was paid?”
“What returns money on a scheduled Open Finance payment?”
Tell an agent
Refund scheduled payment {identificadorPagamento}.
Return the money on scheduled Pix {identificadorPagamento}.

Documentation

Specifications

Schemas & Data

Other Resources

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-scheduled-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.

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

OpenAPI Specification

gerencianet-scheduled-pix-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Efí Pay Open Finance Scheduled Pix API
  description: Open Finance Brasil payment-initiation API for Efí Pay (formerly Gerencianet). Initiate Pix payments across participating banks and fintechs without redirecting users out of your app, including immediate, scheduled, recurring, biometric, and automatic Pix flows. Requires mTLS, OAuth2 client_credentials, and x-idempotency-key headers on every request.
  version: '1.0'
  contact:
    name: Efí Pay Developer Support
    url: https://dev.efipay.com.br/docs/open-finance
  license:
    name: Proprietary
servers:
- url: https://openfinance.api.efipay.com.br/v1
  description: Production
- url: https://openfinance-h.api.efipay.com.br/v1
  description: Homologation (Sandbox)
security:
- oauth2OpenFinance: []
tags:
- name: Scheduled Pix
paths:
  /pagamentos-agendados/pix:
    post:
      tags:
      - Scheduled Pix
      summary: Start Scheduled Pix
      operationId: ofStartSchedulePixPayment
      responses:
        '201':
          description: Scheduled
    get:
      tags:
      - Scheduled Pix
      summary: List Scheduled Pix
      operationId: ofListSchedulePixPayment
      responses:
        '200':
          description: Scheduled list
  /pagamentos-agendados/pix/{identificadorPagamento}/cancelar:
    patch:
      tags:
      - Scheduled Pix
      summary: Cancel Scheduled Pix
      operationId: ofCancelSchedulePix
      parameters:
      - name: identificadorPagamento
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Cancelled
  /pagamentos-agendados/pix/{identificadorPagamento}/devolver:
    post:
      tags:
      - Scheduled Pix
      summary: Refund Scheduled Pix
      operationId: ofDevolutionSchedulePix
      parameters:
      - name: identificadorPagamento
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Refunded
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