Efí Pay (Gerencianet) · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Efí Pay Pix Due Charge Batches API

5 actions 5 updates phrasing extends openapi/gerencianet-due-charge-batches-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['/v2/lotecobv'].get

$.paths['/v2/lotecobv/{id}'].get

$.paths['/v2/lotecobv/{id}'].put

$.paths['/v2/lotecobv/{id}'].patch

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 Pix Due Charge Batches API
  version: 1.0.0
extends: openapi/gerencianet-due-charge-batches-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['/v2/lotecobv'].get
  update:
    x-apievangelist-phrasing:
      intent: List batches of Pix due charges
      effect: read
      questions:
      - Which batches of due-date Pix charges have I submitted?
      - Can I see all my cobv batches?
      instructions:
      - text: List my due charge batches.
      - text: Show all batches of Pix charges with due dates.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/lotecobv/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a batch of Pix due charges
      effect: read
      questions:
      - Can I check how each charge in a batch was processed?
      - What status is a due charge batch in?
      instructions:
      - text: Show due charge batch {id}.
        slots:
          id: path.id
      - text: Get the results of batch {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/lotecobv/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create a batch of Pix due charges
      effect: write
      questions:
      - How do I issue many Pix charges with due dates in one request?
      - Can I create cobv charges in bulk?
      instructions:
      - text: Create due charge batch {id}.
        slots:
          id: path.id
      - text: Submit batch {id} of Pix charges with due dates.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/lotecobv/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update charges in a due charge batch
      effect: write
      questions:
      - Can I change charges inside a batch I already submitted?
      - What revises a batch of Pix due charges?
      instructions:
      - text: Update due charge batch {id}.
        slots:
          id: path.id
      - text: Revise the charges in batch {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'