Efí Pay (Gerencianet) · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Efí Pay Cobranças Card Payments API

4 actions 4 updates phrasing extends openapi/gerencianet-card-payments-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 4

$.info
$.paths['/charge/{id}/retry'].post
$.paths['/charge/card/{id}/refund'].post
$.paths['/installments'].get

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 Card Payments API
  version: 1.0.0
extends: openapi/gerencianet-card-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: 3
- target: $.paths['/charge/{id}/retry'].post
  update:
    x-apievangelist-phrasing:
      intent: Retry a declined card payment
      effect: write
      questions:
      - Can I retry a credit card charge that was declined?
      - What do I call to attempt a card payment again?
      instructions:
      - text: Retry the card payment on charge {id}.
        slots:
          id: path.id
      - text: Attempt card charge {id} again.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/charge/card/{id}/refund'].post
  update:
    x-apievangelist-phrasing:
      intent: Refund a card charge
      effect: write
      questions:
      - How do I refund a credit card charge?
      - Can I give money back on a card payment through the API?
      instructions:
      - text: Refund card charge {id}.
        slots:
          id: path.id
      - text: Return the money on credit card charge {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/installments'].get
  update:
    x-apievangelist-phrasing:
      intent: Get card installment options
      effect: read
      questions:
      - How many installments can a customer split a card payment into?
      - What are the installment values for a credit card purchase?
      instructions:
      - text: Show the installment options for a card payment.
      - text: Get the available credit card installments.
      method: generated
      generated: '2026-10-01'