Efí Pay (Gerencianet) · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Efí Pay Pix Devolutions API

3 actions 3 updates phrasing extends openapi/gerencianet-devolutions-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/{e2eId}/devolucao/{id}'].get
$.paths['/v2/pix/{e2eId}/devolucao/{id}'].put

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 Devolutions API
  version: 1.0.0
extends: openapi/gerencianet-devolutions-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/{e2eId}/devolucao/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Pix refund
      effect: read
      questions:
      - Can I check the status of a refund I made on a received Pix?
      - What details does a Pix devolution return?
      instructions:
      - text: Show devolution {id} on Pix {e2eId}.
        slots:
          e2eId: path.e2eId
          id: path.id
      - text: Get the status of refund {id} for Pix {e2eId}.
        slots:
          e2eId: path.e2eId
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/pix/{e2eId}/devolucao/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Refund a received Pix
      effect: write
      questions:
      - How do I send money back to someone who paid me by Pix?
      - Can I request a devolution on a Pix I received?
      instructions:
      - text: Refund Pix {e2eId} under devolution id {id}.
        slots:
          e2eId: path.e2eId
          id: path.id
      - text: Create devolution {id} for received Pix {e2eId}.
        slots:
          e2eId: path.e2eId
          id: path.id
      method: generated
      generated: '2026-10-01'