Efí Pay (Gerencianet)

Efí Pay (Gerencianet) Splits API

The Splits API from Efí Pay (Gerencianet) — 6 operation(s) for splits.

GitHub OpenAPI
Business capability
Payments & Card Management BC-1340

Operations 9

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /v2/gn/split/cob/{txid} See the split on an immediate Pix charge · Detail Charge Split #
Ask an LLM
“Can I see how an immediate Pix charge's money is split?”
“Which split configuration applies to a cob charge?”
Tell an agent
Show the split for immediate charge {txid}.
Get the payment split on cob {txid}.
PUT /v2/gn/split/cob/{txid}/vinculo/{splitConfigId} Apply a split to an immediate Pix charge · Link Split To Charge #
Ask an LLM
“How do I split an immediate Pix charge between accounts?”
“Can I attach a split configuration to a cob charge?”
Tell an agent
Link split {splitConfigId} to immediate charge {txid}.
Apply split configuration {splitConfigId} to cob {txid}.
DELETE /v2/gn/split/cob/{txid}/vinculo/{splitConfigId} Remove a split from an immediate Pix charge · Unlink Split From Charge #
Ask an LLM
“Can I remove a split from an immediate Pix charge?”
“What detaches a split configuration from a cob?”
Tell an agent destructive · confirm first
Unlink split {splitConfigId} from immediate charge {txid}.
Remove split configuration {splitConfigId} from cob {txid}.
GET /v2/gn/split/cobv/{txid} See the split on a Pix due charge · Detail Due Charge Split #
Ask an LLM
“Can I see how a due-date Pix charge's money is split?”
“Which split configuration applies to a cobv charge?”
Tell an agent
Show the split for due charge {txid}.
Get the payment split on cobv {txid}.
PUT /v2/gn/split/cobv/{txid}/vinculo/{splitConfigId} Apply a split to a Pix due charge · Link Split To Due Charge #
Ask an LLM
“How do I split a due-date Pix charge between accounts?”
“Can I attach a split configuration to a cobv charge?”
Tell an agent
Link split {splitConfigId} to due charge {txid}.
Apply split configuration {splitConfigId} to cobv {txid}.
DELETE /v2/gn/split/cobv/{txid}/vinculo/{splitConfigId} Remove a split from a Pix due charge · Unlink Split From Due Charge #
Ask an LLM
“Can I remove a split from a due-date Pix charge?”
“What detaches a split configuration from a cobv?”
Tell an agent destructive · confirm first
Unlink split {splitConfigId} from due charge {txid}.
Remove split configuration {splitConfigId} from cobv {txid}.
POST /v2/gn/split/config Create a Pix split configuration · Create Split Config #
Ask an LLM
“How do I define how Pix payments are divided among accounts?”
“Can I create a split configuration and let the system assign its id?”
Tell an agent
Create a new split configuration.
Define a Pix payment split with a generated id.
PUT /v2/gn/split/config/{id} Create or update a split configuration by id · Update Split Config #
Ask an LLM
“Can I change an existing split configuration?”
“How do I save a split configuration under my own id?”
Tell an agent
Update split configuration {id}.
Save split config under id {id}.
GET /v2/gn/split/config/{id} Get a Pix split configuration · Detail Split Config #
Ask an LLM
“Can I look up a split configuration by id?”
“How is a given split configuration set up?”
Tell an agent
Show split configuration {id}.
Get the details of split config {id}.

Documentation

📖
Documentation
https://dev.efipay.com.br/docs/api-cobrancas/credenciais
📖
APIReference
https://dev.efipay.com.br
📖
Documentation
https://dev.efipay.com.br/docs/api-pix/credenciais
📖
APIReference
https://dev.efipay.com.br/docs/api-pix
📖
Documentation
https://dev.efipay.com.br/docs/open-finance
📖
Documentation
https://dev.efipay.com.br/docs/abertura-de-contas
📖
Documentation
https://dev.efipay.com.br/docs/api-pagamentos
📖
Documentation
https://dev.efipay.com.br/docs/extrato-cnab

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/gerencianet/refs/heads/main/openapi/gerencianet-splits-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/gerencianet/refs/heads/main/json-schema/efi-cobrancas-charge-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/gerencianet/refs/heads/main/json-structure/efi-cobrancas-charge-structure.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/gerencianet/refs/heads/main/json-schema/efi-pix-cob-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/gerencianet/refs/heads/main/json-schema/efi-pix-pix-received-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/gerencianet/refs/heads/main/json-structure/efi-pix-cob-structure.json

Other Resources

🔗
BaseURL
https://cobrancas.api.efipay.com.br/v1
🔗
SandboxURL
https://cobrancas-h.api.efipay.com.br/v1
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/gerencianet/refs/heads/main/examples/efi-cobrancas-onestep-example.json
🔗
BaseURL
https://pix.api.efipay.com.br
🔗
SandboxURL
https://pix-h.api.efipay.com.br
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/gerencianet/refs/heads/main/examples/efi-pix-create-cob-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/gerencianet/refs/heads/main/examples/efi-pix-send-example.json
🔗
BaseURL
https://openfinance.api.efipay.com.br/v1
🔗
SandboxURL
https://openfinance-h.api.efipay.com.br/v1
🔗
BaseURL
https://abrircontas.api.efipay.com.br/v1
🔗
SandboxURL
https://abrircontas-h.api.efipay.com.br/v1
🔗
BaseURL
https://pagarcontas.api.efipay.com.br/v1
🔗
SandboxURL
https://pagarcontas-h.api.efipay.com.br/v1
🔗
BaseURL
https://extratos.api.efipay.com.br/v1
🔗
SandboxURL
https://extratos-h.api.efipay.com.br/v1

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/gerencianet:gerencianet-splits-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

gerencianet-splits-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Efí Pay Pix Splits API
  description: Brazilian Pix instant-payments API for Efí Pay (formerly Gerencianet). Implements the Banco Central do Brasil Pix specification (cob/cobv/cobr, locations, devolutions, Pix keys/EVP) plus Efí Pay extensions for Cash-Out (pixSend), splits, MED infractions, recurring/automatic Pix, statements, receipts, and webhooks. OAuth2 client_credentials with mandatory mutual TLS (P12/PEM certificate).
  version: '2.0'
  contact:
    name: Efí Pay Developer Support
    url: https://dev.efipay.com.br/docs/api-pix
  license:
    name: Proprietary
servers:
- url: https://pix.api.efipay.com.br
  description: Production
- url: https://pix-h.api.efipay.com.br
  description: Homologation (Sandbox)
security:
- oauth2Pix: []
tags:
- name: Splits
paths:
  /v2/gn/split/cob/{txid}:
    get:
      tags:
      - Splits
      summary: Detail Charge Split
      operationId: pixSplitDetailCharge
      parameters:
      - name: txid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Split
  /v2/gn/split/cob/{txid}/vinculo/{splitConfigId}:
    put:
      tags:
      - Splits
      summary: Link Split To Charge
      operationId: pixSplitLinkCharge
      parameters:
      - name: txid
        in: path
        required: true
        schema:
          type: string
      - name: splitConfigId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Linked
    delete:
      tags:
      - Splits
      summary: Unlink Split From Charge
      operationId: pixSplitUnlinkCharge
      parameters:
      - name: txid
        in: path
        required: true
        schema:
          type: string
      - name: splitConfigId
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Unlinked
  /v2/gn/split/cobv/{txid}:
    get:
      tags:
      - Splits
      summary: Detail Due Charge Split
      operationId: pixSplitDetailDueCharge
      parameters:
      - name: txid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Split
  /v2/gn/split/cobv/{txid}/vinculo/{splitConfigId}:
    put:
      tags:
      - Splits
      summary: Link Split To Due Charge
      operationId: pixSplitLinkDueCharge
      parameters:
      - name: txid
        in: path
        required: true
        schema:
          type: string
      - name: splitConfigId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Linked
    delete:
      tags:
      - Splits
      summary: Unlink Split From Due Charge
      operationId: pixSplitUnlinkDueCharge
      parameters:
      - name: txid
        in: path
        required: true
        schema:
          type: string
      - name: splitConfigId
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Unlinked
  /v2/gn/split/config:
    post:
      tags:
      - Splits
      summary: Create Split Config
      operationId: pixSplitConfig
      responses:
        '201':
          description: Created
  /v2/gn/split/config/{id}:
    put:
      tags:
      - Splits
      summary: Update Split Config
      operationId: pixSplitConfigId
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Updated
    get:
      tags:
      - Splits
      summary: Detail Split Config
      operationId: pixSplitDetailConfig
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Config
components:
  securitySchemes:
    oauth2Pix:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://pix.api.efipay.com.br/oauth/token
          scopes:
            cob.read: Read immediate charges
            cob.write: Create/update immediate charges
            cobv.read: Read due charges
            cobv.write: Create/update due charges
            pix.read: Read received Pix
            pix.write: Manage devolutions
            pix.send: Send Pix
            webhook.read: Read webhook config
            webhook.write: Configure webhooks
            gn.balance.read: Read account balance