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) Automatic Charges API

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

Efí Pay (Gerencianet) Automatic Charges 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 Automatic Charges. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and 5 JSON Schemas.

This API exposes 6 operations across 3 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.

6 operations 3 paths 0 schemas 2 GET1 PATCH2 POST1 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) Automatic Charges 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 6

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

Automatic Charges 6
POST
/v2/cobr
Create Automatic Pix Charge
pixCreateAutomaticCharge → 201
GET
/v2/cobr
List Automatic Pix Charges
pixListAutomaticCharge → 200
PUT
/v2/cobr/{txid}
Create Automatic Pix Charge With Txid
pixCreateAutomaticChargeTxid 1 param → 201
PATCH
/v2/cobr/{txid}
Update Automatic Pix Charge
pixUpdateAutomaticCharge 1 param → 200
GET
/v2/cobr/{txid}
Detail Automatic Pix Charge
pixDetailAutomaticCharge 1 param → 200
POST
/v2/cobr/{txid}/retentativa/{data}
Retry Automatic Pix Charge
pixRetryRequestAutomaticCharge 2 params → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

gerencianet-automatic-charges-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 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
Efí Pay (Gerencianet) Due Charge Batches API