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.
# 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 Open Finance Immediate Pix API
version: 1.0.0
extends: openapi/gerencianet-immediate-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: 3
- target: $.paths['/pagamentos/pix'].get
update:
x-apievangelist-phrasing:
intent: List Open Finance Pix payments
effect: read
questions:
- Which Pix payments have I initiated through Open Finance?
- Can I see the status of my Open Finance payment initiations?
instructions:
- text: List my Open Finance Pix payments.
- text: Show payments I started through Open Finance.
method: generated
generated: '2026-10-01'
- target: $.paths['/pagamentos/pix'].post
update:
x-apievangelist-phrasing:
intent: Initiate a Pix payment via Open Finance
effect: write
questions:
- How do I start a Pix payment from the payer's bank through Open Finance?
- Can I initiate an immediate Pix payment with Open Finance?
instructions:
- text: Start an Open Finance Pix payment.
- text: Initiate an immediate Pix payment from the payer's bank.
method: generated
generated: '2026-10-01'
- target: $.paths['/pagamentos/pix/{identificadorPagamento}/devolver'].post
update:
x-apievangelist-phrasing:
intent: Refund an Open Finance Pix payment
effect: write
questions:
- Can I refund a Pix payment that was initiated through Open Finance?
- What returns money on an Open Finance payment?
instructions:
- text: Refund Open Finance payment {identificadorPagamento}.
slots:
identificadorPagamento: path.identificadorPagamento
- text: Return the money on Pix payment {identificadorPagamento}.
slots:
identificadorPagamento: path.identificadorPagamento
method: generated
generated: '2026-10-01'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.