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

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

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

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

12 operations 12 paths 0 schemas 2 GET6 POST4 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) 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 12

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

Charges 12
POST
/charge
Create Charge
createCharge → 200
POST
/charge/one-step
Create One Step Charge
createOneStepCharge → 200
GET
/charge/{id}
Detail Charge
detailCharge 1 param → 200
GET
/charges
List Charges
listCharges → 200
PUT
/charge/{id}/cancel
Cancel Charge
cancelCharge 1 param → 200
POST
/charge/{id}/pay
Define Payment Method
definePayMethod 1 param → 200
PUT
/charge/{id}/billet
Update Billet
updateBillet 1 param → 200
POST
/charge/{id}/billet/resend
Send Billet Email
sendBilletEmail 1 param → 200
PUT
/charge/{id}/metadata
Update Charge Metadata
updateChargeMetadata 1 param → 200
POST
/charge/{id}/history
Create Charge History Note
createChargeHistory 1 param → 200
POST
/charge/{id}/balance-sheet
Define Balance Sheet Billet
defineBalanceSheetBillet 1 param → 200
PUT
/charge/{id}/settle
Settle Charge Manually
settleCharge 1 param → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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