Efí Pay (Gerencianet) · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Efí Pay Pix Received Pix API

3 actions 3 updates phrasing extends openapi/gerencianet-received-pix-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/pix'].get

$.paths['/v2/pix/{e2eId}'].get

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 Received Pix API
  version: 1.0.0
extends: openapi/gerencianet-received-pix-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/pix'].get
  update:
    x-apievangelist-phrasing:
      intent: List Pix I received
      effect: read
      questions:
      - Which Pix payments have I received?
      - Can I see all incoming Pix on my account?
      instructions:
      - text: List the Pix I've received.
      - text: Show my incoming Pix payments.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/pix/{e2eId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a received Pix
      effect: read
      questions:
      - Can I look up an incoming Pix by its end-to-end id?
      - What details come with a Pix I received?
      instructions:
      - text: Show received Pix {e2eId}.
        slots:
          e2eId: path.e2eId
      - text: Get incoming Pix with end-to-end id {e2eId}.
        slots:
          e2eId: path.e2eId
      method: generated
      generated: '2026-10-01'