Efí Pay (Gerencianet) Webhooks API

The Webhooks API from Efí Pay (Gerencianet) — 8 operation(s) for webhooks.

Documentation GitHub OpenAPI

Business capability

Webhook & Event Subscription Management BC-4270.80

Operations 15

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 /webhook Register an account webhook · Configure Account Webhook #

Ask an LLM

“How do I register a webhook for account events?”

“Can I subscribe a URL to account notifications?”

Tell an agent

Configure a new account webhook.

Register my URL for account event notifications.

GET /webhook/{identificadorWebhook} Get an account webhook · Detail Account Webhook #

Ask an LLM

“Can I look up one account webhook by its identifier?”

“Which URL is an account webhook pointing to?”

Tell an agent

Show account webhook {identificadorWebhook}.

Get the details of account webhook {identificadorWebhook}.

DELETE /webhook/{identificadorWebhook} Delete an account webhook · Delete Account Webhook #

Ask an LLM

“Can I remove an account webhook I no longer need?”

“What stops notifications to an account webhook?”

Tell an agent destructive · confirm first

Delete account webhook {identificadorWebhook}.

Remove account webhook {identificadorWebhook}.

GET /webhooks List account webhooks · List Account Webhooks #

Ask an LLM

“Which account webhooks have I registered?”

“Can I see all webhooks set up for account events?”

Tell an agent

List my account webhooks.

Show every account event webhook.

PUT /v2/webhook/{chave} Set the webhook for a Pix key · Configure Pix Webhook #

Ask an LLM

“How do I get notified when a Pix arrives on one of my keys?”

“Can I point a Pix key's notifications at my URL?”

Tell an agent

Configure the Pix webhook for key {chave}.

Send Pix notifications for key {chave} to my URL.

GET /v2/webhook/{chave} Get the webhook for a Pix key · Detail Pix Webhook #

Ask an LLM

“Which webhook URL is set on a given Pix key?”

“Can I check the webhook configured for one of my keys?”

Tell an agent

Show the Pix webhook for key {chave}.

Get the webhook URL on Pix key {chave}.

DELETE /v2/webhook/{chave} Remove the webhook from a Pix key · Delete Pix Webhook #

Ask an LLM

“Can I stop Pix notifications for a specific key?”

“What deletes the webhook on a Pix key?”

Tell an agent destructive · confirm first

Delete the Pix webhook on key {chave}.

Stop webhook notifications for Pix key {chave}.

GET /v2/webhook List Pix key webhooks · List Pix Webhooks #

Ask an LLM

“Which of my Pix keys have webhooks configured?”

“Can I see every Pix webhook on my account?”

Tell an agent

List my Pix webhooks.

Show all webhooks set on my Pix keys.

PUT /v2/webhookrec Set the Pix Automático recurrence webhook · Configure Recurring Pix Webhook #

Ask an LLM

“How do I get notified when a Pix Automático recurrence changes?”

“Can I register a URL for rec events?”

Tell an agent

Configure the recurrence webhook.

Send Pix Automático recurrence events to my URL.

GET /v2/webhookrec List Pix Automático recurrence webhooks · List Recurring Pix Webhooks #

Ask an LLM

“Which webhook receives my Pix Automático recurrence events?”

“Can I see the rec webhooks configured?”

Tell an agent

List my recurrence webhooks.

Show the webhook for Pix Automático recurrence events.

DELETE /v2/webhookrec Remove the Pix Automático recurrence webhook · Delete Recurring Pix Webhook #

Ask an LLM

“Can I stop receiving recurrence webhook events?”

“What deletes the rec webhook?”

Tell an agent destructive · confirm first

Delete the recurrence webhook.

Stop Pix Automático recurrence notifications.

PUT /v2/webhookcobr Set the Pix Automático charge webhook · Configure Automatic Charge Webhook #

Ask an LLM

“How do I get notified about automatic Pix charge events?”

“Can I register a URL for cobr events?”

Tell an agent

Configure the automatic charge webhook.

Send cobr charge events to my URL.

GET /v2/webhookcobr List Pix Automático charge webhooks · List Automatic Charge Webhooks #

Ask an LLM

“Which webhook receives my automatic Pix charge events?”

“Can I see the cobr webhooks configured?”

Tell an agent

List my automatic charge webhooks.

Show the webhook for cobr charge events.

DELETE /v2/webhookcobr Remove the Pix Automático charge webhook · Delete Automatic Charge Webhook #

Ask an LLM

“Can I stop receiving automatic charge webhook events?”

“What deletes the cobr webhook?”

Tell an agent destructive · confirm first

Delete the automatic charge webhook.

Stop cobr charge notifications.

POST /v2/gn/webhook/reenviar Resend missed Pix webhooks · Resend Pix Webhook #

Ask an LLM

“Can I ask for Pix webhook notifications to be sent again?”

“What do I do if my server missed some Pix notifications?”

Tell an agent

Resend my Pix webhooks.

Redeliver Pix notifications my endpoint missed.

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-webhooks-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

openapi: 3.2.0
info:
  title: Gerencianet Webhooks API
  license:
    name: Proprietary
  version: '1.0'
  description: 'Operations tagged Webhooks across 2 of this provider''s published API definitions: efi-contas-openapi.yml, efi-pix-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://abrircontas.api.efipay.com.br/v1
  description: Production
- url: https://abrircontas-h.api.efipay.com.br/v1
  description: Homologation (Sandbox)
- url: https://pix.api.efipay.com.br
  description: Production
- url: https://pix-h.api.efipay.com.br
  description: Homologation (Sandbox)
tags:
- name: Webhooks
paths:
  /webhook:
    post:
      tags:
      - Webhooks
      summary: Configure Account Webhook
      operationId: accountConfigWebhook
      responses:
        '201':
          description: Webhook configured
      security:
      - oauth2Contas: []
    servers:
    - url: https://abrircontas.api.efipay.com.br/v1
      description: Production
    - url: https://abrircontas-h.api.efipay.com.br/v1
      description: Homologation (Sandbox)
  /webhook/{identificadorWebhook}:
    get:
      tags:
      - Webhooks
      summary: Detail Account Webhook
      operationId: accountDetailWebhook
      parameters:
      - name: identificadorWebhook
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Webhook
      security:
      - oauth2Contas: []
    delete:
      tags:
      - Webhooks
      summary: Delete Account Webhook
      operationId: accountDeleteWebhook
      parameters:
      - name: identificadorWebhook
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Deleted
      security:
      - oauth2Contas: []
    servers:
    - url: https://abrircontas.api.efipay.com.br/v1
      description: Production
    - url: https://abrircontas-h.api.efipay.com.br/v1
      description: Homologation (Sandbox)
  /webhooks:
    get:
      tags:
      - Webhooks
      summary: List Account Webhooks
      operationId: accountListWebhook
      responses:
        '200':
          description: Webhooks
      security:
      - oauth2Contas: []
    servers:
    - url: https://abrircontas.api.efipay.com.br/v1
      description: Production
    - url: https://abrircontas-h.api.efipay.com.br/v1
      description: Homologation (Sandbox)
  /v2/webhook/{chave}:
    put:
      tags:
      - Webhooks
      summary: Configure Pix Webhook
      operationId: pixConfigWebhook
      parameters:
      - name: chave
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Configured
      security:
      - oauth2Pix: []
    get:
      tags:
      - Webhooks
      summary: Detail Pix Webhook
      operationId: pixDetailWebhook
      parameters:
      - name: chave
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Webhook
      security:
      - oauth2Pix: []
    delete:
      tags:
      - Webhooks
      summary: Delete Pix Webhook
      operationId: pixDeleteWebhook
      parameters:
      - name: chave
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Deleted
      security:
      - oauth2Pix: []
    servers:
    - url: https://pix.api.efipay.com.br
      description: Production
    - url: https://pix-h.api.efipay.com.br
      description: Homologation (Sandbox)
  /v2/webhook:
    get:
      tags:
      - Webhooks
      summary: List Pix Webhooks
      operationId: pixListWebhook
      responses:
        '200':
          description: Webhooks
      security:
      - oauth2Pix: []
    servers:
    - url: https://pix.api.efipay.com.br
      description: Production
    - url: https://pix-h.api.efipay.com.br
      description: Homologation (Sandbox)
  /v2/webhookrec:
    put:
      tags:
      - Webhooks
      summary: Configure Recurring Pix Webhook
      operationId: pixConfigWebhookRecurrenceAutomatic
      responses:
        '200':
          description: Configured
      security:
      - oauth2Pix: []
    get:
      tags:
      - Webhooks
      summary: List Recurring Pix Webhooks
      operationId: pixListWebhookRecurrenceAutomatic
      responses:
        '200':
          description: Webhooks
      security:
      - oauth2Pix: []
    delete:
      tags:
      - Webhooks
      summary: Delete Recurring Pix Webhook
      operationId: pixDeleteWebhookRecurrenceAutomatic
      responses:
        '204':
          description: Deleted
      security:
      - oauth2Pix: []
    servers:
    - url: https://pix.api.efipay.com.br
      description: Production
    - url: https://pix-h.api.efipay.com.br
      description: Homologation (Sandbox)
  /v2/webhookcobr:
    put:
      tags:
      - Webhooks
      summary: Configure Automatic Charge Webhook
      operationId: pixConfigWebhookAutomaticCharge
      responses:
        '200':
          description: Configured
      security:
      - oauth2Pix: []
    get:
      tags:
      - Webhooks
      summary: List Automatic Charge Webhooks
      operationId: pixListWebhookAutomaticCharge
      responses:
        '200':
          description: Webhooks
      security:
      - oauth2Pix: []
    delete:
      tags:
      - Webhooks
      summary: Delete Automatic Charge Webhook
      operationId: pixDeleteWebhookAutomaticCharge
      responses:
        '204':
          description: Deleted
      security:
      - oauth2Pix: []
    servers:
    - url: https://pix.api.efipay.com.br
      description: Production
    - url: https://pix-h.api.efipay.com.br
      description: Homologation (Sandbox)
  /v2/gn/webhook/reenviar:
    post:
      tags:
      - Webhooks
      summary: Resend Pix Webhook
      operationId: pixResendWebhook
      responses:
        '200':
          description: Resent
      security:
      - oauth2Pix: []
    servers:
    - url: https://pix.api.efipay.com.br
      description: Production
    - url: https://pix-h.api.efipay.com.br
      description: Homologation (Sandbox)
components:
  securitySchemes:
    oauth2Contas:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://abrircontas.api.efipay.com.br/v1/oauth/token
          scopes: {}
    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
x-refined-from:
- efi-contas-openapi.yml
- efi-pix-openapi.yml

Efí Pay (Gerencianet) Webhooks API

Operations 15

Documentation

Specifications

Schemas & Data

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification