Efí Pay (Gerencianet) · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Efí Pay Pix Splits API

10 actions 10 updates phrasing extends openapi/gerencianet-splits-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 10

$.info
$.paths['/v2/gn/split/cob/{txid}'].get
$.paths['/v2/gn/split/cob/{txid}/vinculo/{splitConfigId}'].put
$.paths['/v2/gn/split/cob/{txid}/vinculo/{splitConfigId}'].delete
$.paths['/v2/gn/split/cobv/{txid}'].get
$.paths['/v2/gn/split/cobv/{txid}/vinculo/{splitConfigId}'].put
$.paths['/v2/gn/split/cobv/{txid}/vinculo/{splitConfigId}'].delete
$.paths['/v2/gn/split/config'].post
$.paths['/v2/gn/split/config/{id}'].get
$.paths['/v2/gn/split/config/{id}'].put

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 Pix Splits API
  version: 1.0.0
extends: openapi/gerencianet-splits-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: 9
- target: $.paths['/v2/gn/split/cob/{txid}'].get
  update:
    x-apievangelist-phrasing:
      intent: See the split on an immediate Pix charge
      effect: read
      questions:
      - Can I see how an immediate Pix charge's money is split?
      - Which split configuration applies to a cob charge?
      instructions:
      - text: Show the split for immediate charge {txid}.
        slots:
          txid: path.txid
      - text: Get the payment split on cob {txid}.
        slots:
          txid: path.txid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/gn/split/cob/{txid}/vinculo/{splitConfigId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Apply a split to an immediate Pix charge
      effect: write
      questions:
      - How do I split an immediate Pix charge between accounts?
      - Can I attach a split configuration to a cob charge?
      instructions:
      - text: Link split {splitConfigId} to immediate charge {txid}.
        slots:
          txid: path.txid
          splitConfigId: path.splitConfigId
      - text: Apply split configuration {splitConfigId} to cob {txid}.
        slots:
          txid: path.txid
          splitConfigId: path.splitConfigId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/gn/split/cob/{txid}/vinculo/{splitConfigId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a split from an immediate Pix charge
      effect: destructive
      questions:
      - Can I remove a split from an immediate Pix charge?
      - What detaches a split configuration from a cob?
      instructions:
      - text: Unlink split {splitConfigId} from immediate charge {txid}.
        slots:
          txid: path.txid
          splitConfigId: path.splitConfigId
      - text: Remove split configuration {splitConfigId} from cob {txid}.
        slots:
          txid: path.txid
          splitConfigId: path.splitConfigId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/gn/split/cobv/{txid}'].get
  update:
    x-apievangelist-phrasing:
      intent: See the split on a Pix due charge
      effect: read
      questions:
      - Can I see how a due-date Pix charge's money is split?
      - Which split configuration applies to a cobv charge?
      instructions:
      - text: Show the split for due charge {txid}.
        slots:
          txid: path.txid
      - text: Get the payment split on cobv {txid}.
        slots:
          txid: path.txid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/gn/split/cobv/{txid}/vinculo/{splitConfigId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Apply a split to a Pix due charge
      effect: write
      questions:
      - How do I split a due-date Pix charge between accounts?
      - Can I attach a split configuration to a cobv charge?
      instructions:
      - text: Link split {splitConfigId} to due charge {txid}.
        slots:
          txid: path.txid
          splitConfigId: path.splitConfigId
      - text: Apply split configuration {splitConfigId} to cobv {txid}.
        slots:
          txid: path.txid
          splitConfigId: path.splitConfigId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/gn/split/cobv/{txid}/vinculo/{splitConfigId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a split from a Pix due charge
      effect: destructive
      questions:
      - Can I remove a split from a due-date Pix charge?
      - What detaches a split configuration from a cobv?
      instructions:
      - text: Unlink split {splitConfigId} from due charge {txid}.
        slots:
          txid: path.txid
          splitConfigId: path.splitConfigId
      - text: Remove split configuration {splitConfigId} from cobv {txid}.
        slots:
          txid: path.txid
          splitConfigId: path.splitConfigId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/gn/split/config'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Pix split configuration
      effect: write
      questions:
      - How do I define how Pix payments are divided among accounts?
      - Can I create a split configuration and let the system assign its id?
      instructions:
      - text: Create a new split configuration.
      - text: Define a Pix payment split with a generated id.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/gn/split/config/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Pix split configuration
      effect: read
      questions:
      - Can I look up a split configuration by id?
      - How is a given split configuration set up?
      instructions:
      - text: Show split configuration {id}.
        slots:
          id: path.id
      - text: Get the details of split config {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/gn/split/config/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update a split configuration by id
      effect: write
      questions:
      - Can I change an existing split configuration?
      - How do I save a split configuration under my own id?
      instructions:
      - text: Update split configuration {id}.
        slots:
          id: path.id
      - text: Save split config under id {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'