Efí Pay (Gerencianet)

Efí Pay (Gerencianet) Charges API

The Charges API from Efí Pay (Gerencianet) — 12 operation(s) for charges.

GitHub OpenAPI
Business capability
Accounts Receivable Management BC-200.30

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 /charge Create a charge · Create Charge #
Ask an LLM
“How do I create a charge before choosing how the customer pays?”
“Can I register a charge first and add the payment method later?”
Tell an agent
Create a new charge.
Register a charge without a payment method yet.
POST /charge/one-step Create and pay a charge in one step · Create One Step Charge #
Ask an LLM
“Can I create a charge and set its boleto or card payment in a single call?”
“What is the one-step way to issue a charge?”
Tell an agent
Create a one-step charge.
Issue a charge with its payment method in one call.
GET /charge/{id} Get a charge · Detail Charge #
Ask an LLM
“Can I look up a single charge and see whether it's paid?”
“What details does a charge return?”
Tell an agent
Show charge {id}.
Get the status of charge {id}.
GET /charges List charges · List Charges #
Ask an LLM
“Which charges have I issued?”
“Is there a way to see all my boleto and card charges together?”
Tell an agent
List my charges.
Show all charges on my account.
PUT /charge/{id}/cancel Cancel a charge · Cancel Charge #
Ask an LLM
“Can I cancel a charge the customer hasn't paid?”
“What happens when a charge is cancelled?”
Tell an agent destructive · confirm first
Cancel charge {id}.
Void unpaid charge {id}.
POST /charge/{id}/pay Set the payment method on a charge · Define Payment Method #
Ask an LLM
“How do I turn an existing charge into a boleto or card payment?”
“Can I pick the payment method after the charge was created?”
Tell an agent
Set the payment method for charge {id}.
Pay charge {id} by boleto or card.
PUT /charge/{id}/billet Update an issued boleto · Update Billet #
Ask an LLM
“Can I modify a boleto I already issued?”
“What updates an existing billet?”
Tell an agent
Update the boleto on charge {id}.
Modify the billet issued for charge {id}.
POST /charge/{id}/billet/resend Email a boleto to the customer · Send Billet Email #
Ask an LLM
“Can I resend a boleto to the customer by email?”
“What emails a billet again?”
Tell an agent
Resend the boleto for charge {id}.
Email the billet of charge {id} to the payer.
PUT /charge/{id}/metadata Update a charge's metadata · Update Charge Metadata #
Ask an LLM
“Can I change the metadata stored on a charge?”
“What updates a charge's metadata?”
Tell an agent
Update the metadata of charge {id}.
Set new metadata on charge {id}.
POST /charge/{id}/history Add a note to a charge's history · Create Charge History Note #
Ask an LLM
“Can I add my own note to a charge's history?”
“Where do I log a comment on a charge?”
Tell an agent
Add a history note to charge {id}.
Record a comment on charge {id}.
POST /charge/{id}/balance-sheet Attach a balance sheet to a boleto · Define Balance Sheet Billet #
Ask an LLM
“Can I add a balance sheet to a boleto?”
“What adds a demonstrative table to a billet?”
Tell an agent
Define the balance sheet for charge {id}.
Attach a balance sheet to the boleto of charge {id}.
PUT /charge/{id}/settle Mark a charge as paid manually · Settle Charge Manually #
Ask an LLM
“Can I mark a charge as paid if the customer paid another way?”
“How do I settle a charge manually?”
Tell an agent
Settle charge {id}.
Mark charge {id} as paid.

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-charges-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-charges-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-charges-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Efí Pay Cobranças Charges 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: Charges
paths:
  /charge:
    post:
      tags:
      - Charges
      summary: Create Charge
      operationId: createCharge
      responses:
        '200':
          description: Charge created
  /charge/one-step:
    post:
      tags:
      - Charges
      summary: Create One Step Charge
      operationId: createOneStepCharge
      responses:
        '200':
          description: Charge created
  /charge/{id}:
    get:
      tags:
      - Charges
      summary: Detail Charge
      operationId: detailCharge
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Charge detail
  /charges:
    get:
      tags:
      - Charges
      summary: List Charges
      operationId: listCharges
      responses:
        '200':
          description: Charges list
  /charge/{id}/cancel:
    put:
      tags:
      - Charges
      summary: Cancel Charge
      operationId: cancelCharge
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Cancelled
  /charge/{id}/pay:
    post:
      tags:
      - Charges
      summary: Define Payment Method
      operationId: definePayMethod
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Method applied
  /charge/{id}/billet:
    put:
      tags:
      - Charges
      summary: Update Billet
      operationId: updateBillet
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Updated
  /charge/{id}/billet/resend:
    post:
      tags:
      - Charges
      summary: Send Billet Email
      operationId: sendBilletEmail
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Email queued
  /charge/{id}/metadata:
    put:
      tags:
      - Charges
      summary: Update Charge Metadata
      operationId: updateChargeMetadata
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Metadata updated
  /charge/{id}/history:
    post:
      tags:
      - Charges
      summary: Create Charge History Note
      operationId: createChargeHistory
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Note added
  /charge/{id}/balance-sheet:
    post:
      tags:
      - Charges
      summary: Define Balance Sheet Billet
      operationId: defineBalanceSheetBillet
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Balance sheet set
  /charge/{id}/settle:
    put:
      tags:
      - Charges
      summary: Settle Charge Manually
      operationId: settleCharge
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Settled
components:
  securitySchemes:
    oauth2ClientCredentials:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://cobrancas.api.efipay.com.br/v1/authorize
          scopes: {}