Efí Pay (Gerencianet) · OpenAPI Overlay 1.0.0

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

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

$.info

$.paths['/v2/cob'].get

$.paths['/v2/cob'].post

$.paths['/v2/cob/{txid}'].get

$.paths['/v2/cob/{txid}'].put

$.paths['/v2/cob/{txid}'].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 Immediate Charges API
  version: 1.0.0
extends: openapi/gerencianet-immediate-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: 5
- target: $.paths['/v2/cob'].get
  update:
    x-apievangelist-phrasing:
      intent: List immediate Pix charges
      effect: read
      questions:
      - Which immediate Pix charges have I created?
      - Can I see all my cob charges?
      instructions:
      - text: List my immediate Pix charges.
      - text: Show all instant Pix charges on my account.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/cob'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an immediate Pix charge
      effect: write
      questions:
      - How do I create a Pix charge and let the system generate the txid?
      - Can I issue an instant Pix charge for a QR code?
      instructions:
      - text: Create an immediate Pix charge.
      - text: Issue an instant Pix charge with a generated txid.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/cob/{txid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an immediate Pix charge
      effect: read
      questions:
      - Can I look up an immediate Pix charge by txid?
      - Has a specific cob charge been paid?
      instructions:
      - text: Show immediate Pix charge {txid}.
        slots:
          txid: path.txid
      - text: Get the status of instant charge {txid}.
        slots:
          txid: path.txid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/cob/{txid}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create an immediate Pix charge with my own txid
      effect: write
      questions:
      - Can I choose the txid when creating an immediate Pix charge?
      - What creates an instant charge under an identifier I generated?
      instructions:
      - text: Create immediate Pix charge with txid {txid}.
        slots:
          txid: path.txid
      - text: Issue an instant Pix charge using my txid {txid}.
        slots:
          txid: path.txid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/cob/{txid}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an immediate Pix charge
      effect: write
      questions:
      - Can I change an immediate Pix charge before it's paid?
      - What edits an existing cob charge?
      instructions:
      - text: Update immediate Pix charge {txid}.
        slots:
          txid: path.txid
      - text: Edit instant charge {txid}.
        slots:
          txid: path.txid
      method: generated
      generated: '2026-10-01'