Efí Pay (Gerencianet) · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Efí Pay Extratos (Statements) Statement Files API

3 actions 3 updates phrasing extends openapi/gerencianet-statement-files-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 3

$.info

$.paths['/extrato-cnab/arquivos'].get

$.paths['/extrato-cnab/download/{nome_arquivo}'].get

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 Extratos (Statements) Statement Files API
  version: 1.0.0
extends: openapi/gerencianet-statement-files-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: 2
- target: $.paths['/extrato-cnab/arquivos'].get
  update:
    x-apievangelist-phrasing:
      intent: List CNAB statement files
      effect: read
      questions:
      - Which CNAB statement files are available for my account?
      - Can I see the statement files ready to download?
      instructions:
      - text: List my CNAB statement files.
      - text: Show the statement files available.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/extrato-cnab/download/{nome_arquivo}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a CNAB statement file
      effect: read
      questions:
      - How do I download a specific CNAB statement file?
      - Can I fetch a statement file by its name?
      instructions:
      - text: Download statement file {nome_arquivo}.
        slots:
          nome_arquivo: path.nome_arquivo
      - text: Get CNAB file {nome_arquivo}.
        slots:
          nome_arquivo: path.nome_arquivo
      method: generated
      generated: '2026-10-01'