Efí Pay (Gerencianet)

Efí Pay (Gerencianet) Carnets API

The Carnets API from Efí Pay (Gerencianet) — 12 operation(s) for carnets.

GitHub OpenAPI

Operations 12

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

POST /carnet Create a carnet of installment boletos · Create Carnet #
Ask an LLM
“How do I issue a carnê so a customer pays in monthly boletos?”
“Can I create an installment booklet through the API?”
Tell an agent
Create a new carnet.
Issue an installment booklet of boletos for a customer.
GET /carnet/{id} Get a carnet · Detail Carnet #
Ask an LLM
“Can I look up a carnet and see its installments?”
“What is the status of each parcel in a carnê?”
Tell an agent
Show carnet {id}.
Get the details of carnet {id}.
PUT /carnet/{id}/parcels Update several carnet parcels at once · Update Carnet Parcels #
Ask an LLM
“Can I update several parcels of a carnet at once?”
“How do I reschedule the installments of a carnê in one call?”
Tell an agent
Update the parcels of carnet {id}.
Change multiple installments on carnet {id}.
PUT /carnet/{id}/parcel/{parcel} Update one carnet parcel · Update Carnet Parcel #
Ask an LLM
“Can I change just one installment of a carnet?”
“What do I call to edit a single parcel of a carnê?”
Tell an agent
Update parcel {parcel} of carnet {id}.
Edit installment {parcel} on carnet {id}.
PUT /carnet/{id}/parcel/{parcel}/cancel Cancel one carnet parcel · Cancel Carnet Parcel #
Ask an LLM
“Can I cancel a single installment without cancelling the whole carnet?”
“What happens if I cancel one parcel of a carnê?”
Tell an agent destructive · confirm first
Cancel parcel {parcel} of carnet {id}.
Void installment {parcel} on carnet {id}.
PUT /carnet/{id}/parcel/{parcel}/settle Mark one carnet parcel as paid · Settle Carnet Parcel #
Ask an LLM
“Can I mark a carnet installment as paid when the customer paid outside the system?”
“Is there a way to settle a single parcel manually?”
Tell an agent
Settle parcel {parcel} of carnet {id}.
Mark installment {parcel} on carnet {id} as paid.
POST /carnet/{id}/parcel/{parcel}/resend Email one carnet parcel to the customer · Send Carnet Parcel Email #
Ask an LLM
“Can I resend just one installment's boleto by email?”
“What do I call to email a single carnet parcel again?”
Tell an agent
Resend parcel {parcel} of carnet {id} by email.
Email installment {parcel} of carnet {id} to the payer.
PUT /carnet/{id}/cancel Cancel a whole carnet · Cancel Carnet #
Ask an LLM
“Can I cancel an entire carnê and all its open installments?”
“What cancels a carnet the customer no longer needs?”
Tell an agent destructive · confirm first
Cancel carnet {id}.
Void the whole carnet {id}.
PUT /carnet/{id}/settle Mark a whole carnet as paid · Settle Carnet #
Ask an LLM
“Can I mark an entire carnê as paid in one step?”
“How do I manually settle every installment of a carnet?”
Tell an agent
Settle carnet {id}.
Mark all of carnet {id} as paid.
POST /carnet/{id}/history Add a note to a carnet's history · Create Carnet History Note #
Ask an LLM
“Can I add a custom note to a carnet's history?”
“Where do I record a comment on a carnê?”
Tell an agent
Add a history note to carnet {id}.
Record a comment on carnet {id}.
PUT /carnet/{id}/metadata Update a carnet's metadata · Update Carnet Metadata #
Ask an LLM
“Can I change the metadata stored on a carnet?”
“What updates the metadata of a carnê?”
Tell an agent
Update the metadata of carnet {id}.
Set new metadata on carnet {id}.
POST /carnet/{id}/resend Email the whole carnet to the customer · Send Carnet Email #
Ask an LLM
“Can I resend an entire carnê to the customer by email?”
“What emails the full carnet again?”
Tell an agent
Resend carnet {id} by email.
Email the full carnet {id} to the customer.

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://artifacts.apis.io/gerencianet/openapi/gerencianet-carnets-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/gerencianet/json-schema/efi-cobrancas-charge-schema.json
📊
JSONStructure
https://artifacts.apis.io/gerencianet/json-structure/efi-cobrancas-charge-structure.json
📊
JSONSchema
https://artifacts.apis.io/gerencianet/json-schema/efi-pix-cob-schema.json
📊
JSONSchema
https://artifacts.apis.io/gerencianet/json-schema/efi-pix-pix-received-schema.json
📊
JSONStructure
https://artifacts.apis.io/gerencianet/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://artifacts.apis.io/gerencianet/examples/efi-cobrancas-onestep-example.json
🔗
BaseURL
https://pix.api.efipay.com.br
🔗
SandboxURL
https://pix-h.api.efipay.com.br
🔗
Examples
https://artifacts.apis.io/gerencianet/examples/efi-pix-create-cob-example.json
🔗
Examples
https://artifacts.apis.io/gerencianet/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-carnets-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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-carnets-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Efí Pay Cobranças Carnets API
  description: Billing API for Efí Pay (formerly Gerencianet). Issue boletos (Brazilian bank slips), Bolix (next-business-day boletos), carnês (installment booklets), payment links, credit card charges, subscriptions/recurring billing, and marketplace payment splits. OAuth2 with HTTP Basic for client_credentials.
  version: '1.0'
  contact:
    name: Efí Pay Developer Support
    url: https://dev.efipay.com.br
  license:
    name: Proprietary
servers:
- url: https://cobrancas.api.efipay.com.br/v1
  description: Production
- url: https://cobrancas-h.api.efipay.com.br/v1
  description: Homologation (Sandbox)
security:
- oauth2ClientCredentials: []
tags:
- name: Carnets
paths:
  /carnet:
    post:
      tags:
      - Carnets
      summary: Create Carnet
      operationId: createCarnet
      responses:
        '200':
          description: Carnet created
  /carnet/{id}:
    get:
      tags:
      - Carnets
      summary: Detail Carnet
      operationId: detailCarnet
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Carnet detail
  /carnet/{id}/parcels:
    put:
      tags:
      - Carnets
      summary: Update Carnet Parcels
      operationId: updateCarnetParcels
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Parcels updated
  /carnet/{id}/parcel/{parcel}:
    put:
      tags:
      - Carnets
      summary: Update Carnet Parcel
      operationId: updateCarnetParcel
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
      - name: parcel
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Parcel updated
  /carnet/{id}/parcel/{parcel}/cancel:
    put:
      tags:
      - Carnets
      summary: Cancel Carnet Parcel
      operationId: cancelCarnetParcel
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
      - name: parcel
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Cancelled
  /carnet/{id}/parcel/{parcel}/settle:
    put:
      tags:
      - Carnets
      summary: Settle Carnet Parcel
      operationId: settleCarnetParcel
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
      - name: parcel
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Settled
  /carnet/{id}/parcel/{parcel}/resend:
    post:
      tags:
      - Carnets
      summary: Send Carnet Parcel Email
      operationId: sendCarnetParcelEmail
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
      - name: parcel
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Email queued
  /carnet/{id}/cancel:
    put:
      tags:
      - Carnets
      summary: Cancel Carnet
      operationId: cancelCarnet
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Cancelled
  /carnet/{id}/settle:
    put:
      tags:
      - Carnets
      summary: Settle Carnet
      operationId: settleCarnet
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Settled
  /carnet/{id}/history:
    post:
      tags:
      - Carnets
      summary: Create Carnet History Note
      operationId: createCarnetHistory
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Note added
  /carnet/{id}/metadata:
    put:
      tags:
      - Carnets
      summary: Update Carnet Metadata
      operationId: updateCarnetMetadata
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Metadata updated
  /carnet/{id}/resend:
    post:
      tags:
      - Carnets
      summary: Send Carnet Email
      operationId: sendCarnetEmail
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Email queued
components:
  securitySchemes:
    oauth2ClientCredentials:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://cobrancas.api.efipay.com.br/v1/authorize
          scopes: {}