Efí Pay (Gerencianet) · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Efí Pay Pix Due Charges API

5 actions 5 updates phrasing extends openapi/gerencianet-due-charges-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/cobv'].get
$.paths['/v2/cobv/{txid}'].get
$.paths['/v2/cobv/{txid}'].put
$.paths['/v2/cobv/{txid}'].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 Pix Due Charges API
  version: 1.0.0
extends: openapi/gerencianet-due-charges-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/cobv'].get
  update:
    x-apievangelist-phrasing:
      intent: List Pix charges with due dates
      effect: read
      questions:
      - Which Pix charges with due dates have I issued?
      - Can I see all my cobv charges?
      instructions:
      - text: List my Pix due charges.
      - text: Show all Pix charges that have a due date.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/cobv/{txid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Pix charge with a due date
      effect: read
      questions:
      - Can I look up a due-date Pix charge by txid?
      - Has a specific cobv charge been paid?
      instructions:
      - text: Show Pix due charge {txid}.
        slots:
          txid: path.txid
      - text: Get the status of due-date charge {txid}.
        slots:
          txid: path.txid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/cobv/{txid}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create a Pix charge with a due date
      effect: write
      questions:
      - How do I issue a Pix charge that has a due date?
      - Can I create a cobv charge under my own txid?
      instructions:
      - text: Create Pix due charge {txid}.
        slots:
          txid: path.txid
      - text: Issue a due-date Pix charge with txid {txid}.
        slots:
          txid: path.txid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/cobv/{txid}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a Pix charge with a due date
      effect: write
      questions:
      - Can I change a cobv charge after issuing it?
      - What edits an existing due-date Pix charge?
      instructions:
      - text: Update Pix due charge {txid}.
        slots:
          txid: path.txid
      - text: Edit due-date charge {txid}.
        slots:
          txid: path.txid
      method: generated
      generated: '2026-10-01'