Efí Pay (Gerencianet) · OpenAPI Overlay 1.0.0

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

7 actions 7 updates phrasing extends openapi/gerencianet-automatic-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 7

$.info
$.paths['/pagamentos-automaticos/adesao'].get
$.paths['/pagamentos-automaticos/adesao'].post
$.paths['/pagamentos-automaticos/adesao'].patch
$.paths['/pagamentos-automaticos/pix'].get
$.paths['/pagamentos-automaticos/pix'].post
$.paths['/pagamentos-automaticos/pix'].patch

OpenAPI Overlay

Raw ↑
# 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 Automatic Pix API
  version: 1.0.0
extends: openapi/gerencianet-automatic-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: 6
- target: $.paths['/pagamentos-automaticos/adesao'].get
  update:
    x-apievangelist-phrasing:
      intent: List Open Finance Pix Automático enrollments
      effect: read
      questions:
      - How do I see the Pix Automático enrollments made through Open Finance?
      - Which automatic payment authorizations do my payers have in place?
      instructions:
      - text: List my Open Finance Pix Automático enrollments.
      - text: Show all automatic Pix enrollments.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/pagamentos-automaticos/adesao'].post
  update:
    x-apievangelist-phrasing:
      intent: Enroll a payer in Pix Automático via Open Finance
      effect: write
      questions:
      - Can I ask a payer to authorize Pix Automático through Open Finance?
      - What starts a new automatic Pix enrollment?
      instructions:
      - text: Create a new Pix Automático enrollment.
      - text: Start an Open Finance automatic Pix enrollment for a payer.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/pagamentos-automaticos/adesao'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a Pix Automático enrollment
      effect: write
      questions:
      - Can I change an Open Finance Pix Automático enrollment after it was set up?
      - How do I modify an existing automatic Pix enrollment?
      instructions:
      - text: Update a Pix Automático enrollment.
      - text: Change the settings of an automatic Pix enrollment.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/pagamentos-automaticos/pix'].get
  update:
    x-apievangelist-phrasing:
      intent: List Open Finance Pix Automático payments
      effect: read
      questions:
      - How can I see the payments collected under Pix Automático enrollments?
      - Which automatic Pix payments have been made through Open Finance?
      instructions:
      - text: List my automatic Pix payments.
      - text: Show payments made under Pix Automático enrollments.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/pagamentos-automaticos/pix'].post
  update:
    x-apievangelist-phrasing:
      intent: Initiate a Pix Automático payment
      effect: write
      questions:
      - Can I trigger a payment under an existing Pix Automático enrollment?
      - What do I call to collect an automatic Pix payment via Open Finance?
      instructions:
      - text: Create an automatic Pix payment.
      - text: Initiate a payment under a Pix Automático enrollment.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/pagamentos-automaticos/pix'].patch
  update:
    x-apievangelist-phrasing:
      intent: Cancel a Pix Automático payment
      effect: destructive
      questions:
      - Can I cancel an automatic Pix payment before it settles?
      - What stops a scheduled Pix Automático payment from going through?
      instructions:
      - text: Cancel an automatic Pix payment.
      - text: Stop a pending Pix Automático payment.
      method: generated
      generated: '2026-10-01'