Efí Pay (Gerencianet) · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Efí Pay Cobranças Payment Links API

5 actions 5 updates phrasing extends openapi/gerencianet-payment-links-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 5

$.info
$.paths['/charge/one-step/link'].post
$.paths['/charge/{id}/link'].put
$.paths['/charge/{id}/link'].post
$.paths['/charge/{id}/link/resend'].post

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 Cobranças Payment Links API
  version: 1.0.0
extends: openapi/gerencianet-payment-links-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['/charge/one-step/link'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a payment link in one step
      effect: write
      questions:
      - Can I create a charge and its payment link in a single call?
      - What is the quickest way to get a checkout link for a new charge?
      instructions:
      - text: Create a one-step payment link.
      - text: Generate a new charge with a payment link in one call.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/charge/{id}/link'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a charge's payment link
      effect: write
      questions:
      - Can I change a payment link after it was generated?
      - What edits the link on an existing charge?
      instructions:
      - text: Update the payment link on charge {id}.
        slots:
          id: path.id
      - text: Edit the link for charge {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/charge/{id}/link'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a payment link for an existing charge
      effect: write
      questions:
      - How do I turn an existing charge into a payment link?
      - Can I let the customer choose how to pay a charge I already created?
      instructions:
      - text: Create a payment link for charge {id}.
        slots:
          id: path.id
      - text: Generate a link for existing charge {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/charge/{id}/link/resend'].post
  update:
    x-apievangelist-phrasing:
      intent: Email a payment link to the customer
      effect: write
      questions:
      - Can I resend a payment link by email?
      - What emails the link of a charge to the payer again?
      instructions:
      - text: Resend the payment link for charge {id}.
        slots:
          id: path.id
      - text: Email the link of charge {id} to the customer.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'