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

The Subscriptions API from Efí Pay (Gerencianet) — 9 operation(s) for subscriptions.

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

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

10 operations 9 paths 0 schemas 1 GET6 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) Subscriptions 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 10

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

Subscriptions 10
POST
/plan/{id}/subscription
Create Subscription
createSubscription 1 param → 200
POST
/plan/{id}/subscription/one-step
Create One Step Subscription
createOneStepSubscription 1 param → 200
POST
/plan/{id}/subscription/one-step/link
Create One Step Subscription Link
createOneStepSubscriptionLink 1 param → 200
GET
/subscription/{id}
Detail Subscription
detailSubscription 1 param → 200
PUT
/subscription/{id}
Update Subscription
updateSubscription 1 param → 200
POST
/subscription/{id}/pay
Define Subscription Payment Method
defineSubscriptionPayMethod 1 param → 200
PUT
/subscription/{id}/cancel
Cancel Subscription
cancelSubscription 1 param → 200
PUT
/subscription/{id}/metadata
Update Subscription Metadata
updateSubscriptionMetadata 1 param → 200
POST
/subscription/{id}/history
Create Subscription History Note
createSubscriptionHistory 1 param → 200
POST
/charge/{id}/subscription/resend
Send Subscription Link Email
sendSubscriptionLinkEmail 1 param → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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