Efí Pay (Gerencianet) · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Efí Pay Open Finance Biometric Pix API

6 actions 6 updates phrasing extends openapi/gerencianet-biometric-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 6

$.info

$.paths['/pagamentos-biometria/vinculos'].get

$.paths['/pagamentos-biometria/vinculos'].post

$.paths['/pagamentos-biometria/vinculos'].patch

$.paths['/pagamentos-biometria/pix'].get

$.paths['/pagamentos-biometria/pix'].post

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 Open Finance Biometric Pix API
  version: 1.0.0
extends: openapi/gerencianet-biometric-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: 5
- target: $.paths['/pagamentos-biometria/vinculos'].get
  update:
    x-apievangelist-phrasing:
      intent: List biometric Pix enrollments
      effect: read
      questions:
      - How do I see the devices or payers linked for biometric Pix?
      - Which biometric enrollments are active on my account?
      instructions:
      - text: List my biometric Pix enrollments.
      - text: Show all biometric payment links.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/pagamentos-biometria/vinculos'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a biometric Pix enrollment
      effect: write
      questions:
      - Can I link a payer so they can pay Pix with biometrics?
      - What sets up a new biometric enrollment for Pix payments?
      instructions:
      - text: Create a biometric Pix enrollment.
      - text: Link a new payer for biometric Pix payments.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/pagamentos-biometria/vinculos'].patch
  update:
    x-apievangelist-phrasing:
      intent: Revoke a biometric Pix enrollment
      effect: destructive
      questions:
      - Can I revoke a biometric enrollment so it can no longer authorize payments?
      - How do I remove a biometric Pix link?
      instructions:
      - text: Revoke a biometric Pix enrollment.
      - text: Remove a payer's biometric payment link.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/pagamentos-biometria/pix'].get
  update:
    x-apievangelist-phrasing:
      intent: List biometric Pix payments
      effect: read
      questions:
      - Which Pix payments were authorized with biometrics?
      - Can I list the payments made through biometric enrollments?
      instructions:
      - text: List my biometric Pix payments.
      - text: Show payments authorized by biometrics.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/pagamentos-biometria/pix'].post
  update:
    x-apievangelist-phrasing:
      intent: Initiate a biometric Pix payment
      effect: write
      questions:
      - How do I start a Pix payment that the payer approves with biometrics?
      - Can I charge a linked payer without redirecting them to their bank?
      instructions:
      - text: Create a biometric Pix payment.
      - text: Start a Pix payment using a biometric enrollment.
      method: generated
      generated: '2026-10-01'