Efí Pay (Gerencianet) Immediate Charges API

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

Operations 5

POST /v2/cob Create Immediate Pix Charge #
GET /v2/cob List Immediate Pix Charges #
PUT /v2/cob/{txid} Create Immediate Pix Charge With Txid #
PATCH /v2/cob/{txid} Update Immediate Pix Charge #
GET /v2/cob/{txid} Detail Immediate Pix Charge #

Documentation

Specifications

Schemas & Data

Other Resources

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-immediate-charges-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.

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

OpenAPI Specification

gerencianet-immediate-charges-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Efí Pay Pix Immediate Charges 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: Immediate Charges
paths:
  /v2/cob:
    post:
      tags:
      - Immediate Charges
      summary: Create Immediate Pix Charge
      operationId: pixCreateImmediateCharge
      responses:
        '201':
          description: Charge created
    get:
      tags:
      - Immediate Charges
      summary: List Immediate Pix Charges
      operationId: pixListCharges
      responses:
        '200':
          description: Charges
  /v2/cob/{txid}:
    put:
      tags:
      - Immediate Charges
      summary: Create Immediate Pix Charge With Txid
      operationId: pixCreateCharge
      parameters:
      - name: txid
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Created
    patch:
      tags:
      - Immediate Charges
      summary: Update Immediate Pix Charge
      operationId: pixUpdateCharge
      parameters:
      - name: txid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Updated
    get:
      tags:
      - Immediate Charges
      summary: Detail Immediate Pix Charge
      operationId: pixDetailCharge
      parameters:
      - name: txid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Charge
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