Efí Pay (Gerencianet) · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Efí Pay Open Finance Scheduled Pix API

5 actions 5 updates phrasing extends openapi/gerencianet-scheduled-pix-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Efí Pay (Gerencianet)'s API. It is a proposal applied on top of the contract, not a document Efí Pay (Gerencianet) publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info

$.paths['/pagamentos-agendados/pix'].get

$.paths['/pagamentos-agendados/pix'].post

$.paths['/pagamentos-agendados/pix/{identificadorPagamento}/cancelar'].patch

$.paths['/pagamentos-agendados/pix/{identificadorPagamento}/devolver'].post

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Efí Pay Open Finance Scheduled Pix API
  version: 1.0.0
extends: openapi/gerencianet-scheduled-pix-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/pagamentos-agendados/pix'].get
  update:
    x-apievangelist-phrasing:
      intent: List scheduled Open Finance Pix payments
      effect: read
      questions:
      - Which future-dated Pix payments have I scheduled through Open Finance?
      - Can I see my scheduled Pix payments?
      instructions:
      - text: List my scheduled Pix payments.
      - text: Show Pix payments scheduled for a future date.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/pagamentos-agendados/pix'].post
  update:
    x-apievangelist-phrasing:
      intent: Schedule a Pix payment via Open Finance
      effect: write
      questions:
      - 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?
      instructions:
      - text: Schedule an Open Finance Pix payment.
      - text: Start a future-dated Pix payment.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/pagamentos-agendados/pix/{identificadorPagamento}/cancelar'].patch
  update:
    x-apievangelist-phrasing:
      intent: Cancel a scheduled Pix payment
      effect: destructive
      questions:
      - Can I cancel a scheduled Pix before its date arrives?
      - What stops a future-dated Open Finance payment?
      instructions:
      - text: Cancel scheduled payment {identificadorPagamento}.
        slots:
          identificadorPagamento: path.identificadorPagamento
      - text: Stop scheduled Pix {identificadorPagamento}.
        slots:
          identificadorPagamento: path.identificadorPagamento
      method: generated
      generated: '2026-10-01'
- target: $.paths['/pagamentos-agendados/pix/{identificadorPagamento}/devolver'].post
  update:
    x-apievangelist-phrasing:
      intent: Refund a scheduled Pix payment
      effect: write
      questions:
      - Can I refund a scheduled Pix payment after it was paid?
      - What returns money on a scheduled Open Finance payment?
      instructions:
      - text: Refund scheduled payment {identificadorPagamento}.
        slots:
          identificadorPagamento: path.identificadorPagamento
      - text: Return the money on scheduled Pix {identificadorPagamento}.
        slots:
          identificadorPagamento: path.identificadorPagamento
      method: generated
      generated: '2026-10-01'