Efí Pay (Gerencianet) · OpenAPI Overlay 1.0.0

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

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

$.info
$.paths['/v2/cobr'].get
$.paths['/v2/cobr'].post
$.paths['/v2/cobr/{txid}'].get
$.paths['/v2/cobr/{txid}'].put
$.paths['/v2/cobr/{txid}'].patch
$.paths['/v2/cobr/{txid}/retentativa/{data}'].post

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 Automatic Charges API
  version: 1.0.0
extends: openapi/gerencianet-automatic-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: 6
- target: $.paths['/v2/cobr'].get
  update:
    x-apievangelist-phrasing:
      intent: List Pix Automático charges
      effect: read
      questions:
      - How do I see all the Pix Automático charges I've issued?
      - Which automatic Pix charges exist on my account?
      instructions:
      - text: List my Pix Automático charges.
      - text: Show all automatic Pix charges I've created.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/cobr'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Pix Automático charge
      effect: write
      questions:
      - Can I create an automatic Pix charge and let the system assign its txid?
      - What do I call to bill a customer under an existing Pix Automático recurrence?
      instructions:
      - text: Create a new Pix Automático charge.
      - text: Issue an automatic Pix charge with a generated txid.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/cobr/{txid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Pix Automático charge
      effect: read
      questions:
      - Can I look up one automatic Pix charge by its txid?
      - What status is a specific Pix Automático charge in?
      instructions:
      - text: Show automatic Pix charge {txid}.
        slots:
          txid: path.txid
      - text: Get the details of Pix Automático charge {txid}.
        slots:
          txid: path.txid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/cobr/{txid}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create a Pix Automático charge with my own txid
      effect: write
      questions:
      - Can I choose the txid myself when creating an automatic Pix charge?
      - How do I create a Pix Automático charge under an identifier I generated?
      instructions:
      - text: Create automatic Pix charge with txid {txid}.
        slots:
          txid: path.txid
      - text: Issue a Pix Automático charge using my txid {txid}.
        slots:
          txid: path.txid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/cobr/{txid}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a Pix Automático charge
      effect: write
      questions:
      - Can I change an automatic Pix charge after it was created?
      - How do I edit an existing Pix Automático charge?
      instructions:
      - text: Update automatic Pix charge {txid}.
        slots:
          txid: path.txid
      - text: Edit Pix Automático charge {txid}.
        slots:
          txid: path.txid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/cobr/{txid}/retentativa/{data}'].post
  update:
    x-apievangelist-phrasing:
      intent: Retry a failed Pix Automático charge
      effect: write
      questions:
      - If an automatic Pix charge fails, can I schedule a retry for another date?
      - What do I call to request a new attempt on a Pix Automático charge?
      instructions:
      - text: Retry automatic Pix charge {txid} on {data}.
        slots:
          txid: path.txid
          data: path.data
      - text: Request a new collection attempt for charge {txid} on date {data}.
        slots:
          txid: path.txid
          data: path.data
      method: generated
      generated: '2026-10-01'