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

The Splits API from Efí Pay (Gerencianet) — 6 operation(s) for splits.

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

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

9 operations 6 paths 0 schemas 2 DELETE3 GET1 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) Splits 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 9

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

Splits 9
GET
/v2/gn/split/cob/{txid}
Detail Charge Split
pixSplitDetailCharge 1 param → 200
PUT
/v2/gn/split/cob/{txid}/vinculo/{splitConfigId}
Link Split To Charge
pixSplitLinkCharge 2 params → 200
DELETE
/v2/gn/split/cob/{txid}/vinculo/{splitConfigId}
Unlink Split From Charge
pixSplitUnlinkCharge 2 params → 204
GET
/v2/gn/split/cobv/{txid}
Detail Due Charge Split
pixSplitDetailDueCharge 1 param → 200
PUT
/v2/gn/split/cobv/{txid}/vinculo/{splitConfigId}
Link Split To Due Charge
pixSplitLinkDueCharge 2 params → 200
DELETE
/v2/gn/split/cobv/{txid}/vinculo/{splitConfigId}
Unlink Split From Due Charge
pixSplitUnlinkDueCharge 2 params → 204
POST
/v2/gn/split/config
Create Split Config
pixSplitConfig → 201
PUT
/v2/gn/split/config/{id}
Update Split Config
pixSplitConfigId 1 param → 200
GET
/v2/gn/split/config/{id}
Detail Split Config
pixSplitDetailConfig 1 param → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

gerencianet-splits-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