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 Pagamentos (Bill Payment) Bill Payments API
version: 1.0.0
extends: openapi/gerencianet-bill-payments-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: 4
- target: $.paths['/codBarras/{codBarras}'].get
update:
x-apievangelist-phrasing:
intent: Look up a bill by its barcode
effect: read
questions:
- Can I check what a boleto or bill is for before paying it?
- What details come back when I look up a barcode?
instructions:
- text: Look up barcode {codBarras}.
slots:
codBarras: path.codBarras
- text: Show the bill details for barcode {codBarras}.
slots:
codBarras: path.codBarras
method: generated
generated: '2026-10-01'
- target: $.paths['/codBarras/{codBarras}'].post
update:
x-apievangelist-phrasing:
intent: Pay a bill by barcode
effect: write
questions:
- How do I pay a boleto from my account using its barcode?
- Can I schedule payment of a bill through the API?
instructions:
- text: Pay the bill with barcode {codBarras}.
slots:
codBarras: path.codBarras
- text: Request payment of barcode {codBarras} from my balance.
slots:
codBarras: path.codBarras
method: generated
generated: '2026-10-01'
- target: $.paths['/{idPagamento}'].get
update:
x-apievangelist-phrasing:
intent: Get a bill payment
effect: read
questions:
- Can I check the status of a bill payment I already requested?
- Did a specific bill payment go through?
instructions:
- text: Show bill payment {idPagamento}.
slots:
idPagamento: path.idPagamento
- text: Get the status of payment {idPagamento}.
slots:
idPagamento: path.idPagamento
method: generated
generated: '2026-10-01'
- target: $.paths['/resumo'].get
update:
x-apievangelist-phrasing:
intent: List bill payments
effect: read
questions:
- Which bills have I paid from my Efí account?
- Is there a summary of all my bill payments?
instructions:
- text: List my bill payments.
- text: Show a summary of the bills I've paid.
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.