Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Efí Pay (Gerencianet) Webhooks API

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

Efí Pay (Gerencianet) Webhooks API is one of 36 APIs that Efí Pay (Gerencianet) publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 5 JSON Schema definitions.

Tagged areas include Webhooks. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and 5 JSON Schemas.

This API exposes 15 operations across 8 paths. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against 2 base URLs: https://cobrancas.api.efipay.com.br/v1, https://cobrancas-h.api.efipay.com.br/v1.

15 operations 8 paths 0 schemas 4 DELETE6 GET2 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Servers
https://cobrancas.api.efipay.com.br/v1
https://cobrancas-h.api.efipay.com.br/v1
Authentication
OAuth 2.0
License
Proprietary
Resource Areas
1

Authentication & Security 1

Efí Pay (Gerencianet) Webhooks API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2ClientCredentials) using the clientCredentials flow. By default, every request must be authenticated.

Paths & Operations 15

Across 8 paths, the API surfaces 15 operations — 4 DELETE, 6 GET, 2 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Webhooks 15
POST
/webhook
Configure Account Webhook
accountConfigWebhook → 201
GET
/webhook/{identificadorWebhook}
Detail Account Webhook
accountDetailWebhook 1 param → 200
DELETE
/webhook/{identificadorWebhook}
Delete Account Webhook
accountDeleteWebhook 1 param → 204
GET
/webhooks
List Account Webhooks
accountListWebhook → 200
PUT
/v2/webhook/{chave}
Configure Pix Webhook
pixConfigWebhook 1 param → 200
GET
/v2/webhook/{chave}
Detail Pix Webhook
pixDetailWebhook 1 param → 200
DELETE
/v2/webhook/{chave}
Delete Pix Webhook
pixDeleteWebhook 1 param → 204
GET
/v2/webhook
List Pix Webhooks
pixListWebhook → 200
PUT
/v2/webhookrec
Configure Recurring Pix Webhook
pixConfigWebhookRecurrenceAutomatic → 200
GET
/v2/webhookrec
List Recurring Pix Webhooks
pixListWebhookRecurrenceAutomatic → 200
DELETE
/v2/webhookrec
Delete Recurring Pix Webhook
pixDeleteWebhookRecurrenceAutomatic → 204
PUT
/v2/webhookcobr
Configure Automatic Charge Webhook
pixConfigWebhookAutomaticCharge → 200
GET
/v2/webhookcobr
List Automatic Charge Webhooks
pixListWebhookAutomaticCharge → 200
DELETE
/v2/webhookcobr
Delete Automatic Charge Webhook
pixDeleteWebhookAutomaticCharge → 204
POST
/v2/gn/webhook/reenviar
Resend Pix Webhook
pixResendWebhook → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

gerencianet-webhooks-api-openapi.yml Raw ↑

Other APIs Efí Pay (Gerencianet) publishes across the network.

Efí Pay (Gerencianet) Account API
Efí Pay (Gerencianet) Accounts API
Efí Pay (Gerencianet) Authorization API
Efí Pay (Gerencianet) Automatic Charges API
Efí Pay (Gerencianet) Automatic Pix API
Efí Pay (Gerencianet) Bill Payments API
Efí Pay (Gerencianet) Biometric Pix API
Efí Pay (Gerencianet) Card Payments API
Efí Pay (Gerencianet) Carnets API
Efí Pay (Gerencianet) Charges API
Efí Pay (Gerencianet) Configuration API
Efí Pay (Gerencianet) Devolutions API