Efí Pay (Gerencianet) · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Efí Pay Pix QR Codes API

3 actions 3 updates phrasing extends openapi/gerencianet-qr-codes-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['/v2/loc/{id}/qrcode'].get
$.paths['/v2/gn/qrcodes/detalhar'].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 QR Codes API
  version: 1.0.0
extends: openapi/gerencianet-qr-codes-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['/v2/loc/{id}/qrcode'].get
  update:
    x-apievangelist-phrasing:
      intent: Generate a QR code for a Pix location
      effect: read
      questions:
      - How do I get the QR code image for a Pix charge's location?
      - Can I get the copy-and-paste code for a loc?
      instructions:
      - text: Generate the QR code for location {id}.
        slots:
          id: path.id
      - text: Get the Pix QR image for loc {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/gn/qrcodes/detalhar'].post
  update:
    x-apievangelist-phrasing:
      intent: Decode a Pix QR code
      effect: read
      questions:
      - Can I see what a Pix QR code is charging before I pay it?
      - What details come back when I decode a copy-and-paste Pix code?
      instructions:
      - text: Decode this Pix QR code.
      - text: Show the details of a copy-and-paste Pix code.
      method: generated
      generated: '2026-10-01'