Efí Pay (Gerencianet) · OpenAPI Overlay 1.0.0

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

7 actions 7 updates phrasing extends openapi/gerencianet-pix-send-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['/v3/gn/pix/{idEnvio}'].put
$.paths['/v2/gn/pix/{idEnvio}/qrcode'].put
$.paths['/v2/gn/pix/{idEnvio}/mesma-titularidade'].put
$.paths['/v2/gn/pix/enviados'].get
$.paths['/v2/gn/pix/enviados/{e2eid}'].get
$.paths['/v2/gn/pix/enviados/id-envio/{idEnvio}'].get

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 Pix Send API
  version: 1.0.0
extends: openapi/gerencianet-pix-send-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['/v3/gn/pix/{idEnvio}'].put
  update:
    x-apievangelist-phrasing:
      intent: Send a Pix payment
      effect: write
      questions:
      - How do I send money by Pix from my account to a key?
      - Can I make a Pix cash-out with my own send id?
      instructions:
      - text: Send a Pix with send id {idEnvio}.
        slots:
          idEnvio: path.idEnvio
      - text: Transfer money by Pix under id {idEnvio}.
        slots:
          idEnvio: path.idEnvio
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/gn/pix/{idEnvio}/qrcode'].put
  update:
    x-apievangelist-phrasing:
      intent: Pay a Pix QR code
      effect: write
      questions:
      - Can I pay a Pix QR code from my account through the API?
      - What do I call to pay a copy-and-paste Pix code?
      instructions:
      - text: Pay a Pix QR code with send id {idEnvio}.
        slots:
          idEnvio: path.idEnvio
      - text: Pay this Pix copy-and-paste code under id {idEnvio}.
        slots:
          idEnvio: path.idEnvio
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/gn/pix/{idEnvio}/mesma-titularidade'].put
  update:
    x-apievangelist-phrasing:
      intent: Send Pix to my own account elsewhere
      effect: write
      questions:
      - Can I move money by Pix to another account in my own name?
      - Is there a dedicated call for same-ownership Pix transfers?
      instructions:
      - text: Send a same-ownership Pix with id {idEnvio}.
        slots:
          idEnvio: path.idEnvio
      - text: Move money to my own account at another bank under id {idEnvio}.
        slots:
          idEnvio: path.idEnvio
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/gn/pix/enviados'].get
  update:
    x-apievangelist-phrasing:
      intent: List Pix I sent
      effect: read
      questions:
      - Which Pix transfers have I sent?
      - Can I see a history of my outgoing Pix?
      instructions:
      - text: List the Pix I've sent.
      - text: Show my outgoing Pix transfers.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/gn/pix/enviados/{e2eid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a sent Pix by end-to-end id
      effect: read
      questions:
      - Can I look up a Pix I sent by its end-to-end id?
      - What status is an outgoing Pix with a given E2E id?
      instructions:
      - text: Show sent Pix {e2eid}.
        slots:
          e2eid: path.e2eid
      - text: Get outgoing Pix with end-to-end id {e2eid}.
        slots:
          e2eid: path.e2eid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/gn/pix/enviados/id-envio/{idEnvio}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a sent Pix by my send id
      effect: read
      questions:
      - Can I find an outgoing Pix using the send id I chose?
      - Did the Pix I sent under my own id go through?
      instructions:
      - text: Show the sent Pix with send id {idEnvio}.
        slots:
          idEnvio: path.idEnvio
      - text: Look up outgoing Pix by my id {idEnvio}.
        slots:
          idEnvio: path.idEnvio
      method: generated
      generated: '2026-10-01'