Efí Pay (Gerencianet)

Efí Pay (Gerencianet) Subscriptions API

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

GitHub OpenAPI
Business capability
Subscription Lifecycle Management BC-4240

Operations 10

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /plan/{id}/subscription Subscribe a customer to a plan · Create Subscription #
Ask an LLM
“How do I subscribe a customer to one of my plans?”
“Can I create a subscription now and set the payment method later?”
Tell an agent
Create a subscription on plan {id}.
Subscribe a customer to plan {id}.
POST /plan/{id}/subscription/one-step Subscribe and set payment in one step · Create One Step Subscription #
Ask an LLM
“Can I create a subscription with its card or boleto payment in a single call?”
“What is the one-step way to subscribe someone?”
Tell an agent
Create a one-step subscription on plan {id}.
Subscribe a customer to plan {id} with payment in one call.
GET /subscription/{id} Get a subscription · Detail Subscription #
Ask an LLM
“Can I look up a subscription and its charges?”
“What status is a customer's subscription in?”
Tell an agent
Show subscription {id}.
Get the details of subscription {id}.
PUT /subscription/{id} Update a subscription · Update Subscription #
Ask an LLM
“Can I change a subscription after it started?”
“What edits an existing subscription?”
Tell an agent
Update subscription {id}.
Edit subscription {id}.
POST /subscription/{id}/pay Set the payment method on a subscription · Define Subscription Payment Method #
Ask an LLM
“How do I add the card or boleto payment to a subscription I created?”
“Can I choose how a subscription gets paid after creating it?”
Tell an agent
Set the payment method for subscription {id}.
Pay subscription {id} by card or boleto.
PUT /subscription/{id}/cancel Cancel a subscription · Cancel Subscription #
Ask an LLM
“Can I cancel a customer's subscription?”
“What stops future charges on a subscription?”
Tell an agent destructive · confirm first
Cancel subscription {id}.
Stop recurring billing on subscription {id}.
PUT /subscription/{id}/metadata Update a subscription's metadata · Update Subscription Metadata #
Ask an LLM
“Can I change the custom metadata on a subscription?”
“What updates a subscription's metadata?”
Tell an agent
Update the metadata of subscription {id}.
Change the custom fields on subscription {id}.
POST /subscription/{id}/history Add a note to a subscription's history · Create Subscription History Note #
Ask an LLM
“Can I add my own note to a subscription's history?”
“Where do I log a comment on a subscription?”
Tell an agent
Add a history note to subscription {id}.
Record a comment on subscription {id}.
POST /charge/{id}/subscription/resend Email a subscription link to the customer · Send Subscription Link Email #
Ask an LLM
“Can I resend a subscription payment link by email?”
“What emails the sign-up link for a subscription again?”
Tell an agent
Resend the subscription link for charge {id}.
Email the subscription link on charge {id} to the customer.

Documentation

📖
Documentation
https://dev.efipay.com.br/docs/api-cobrancas/credenciais
📖
APIReference
https://dev.efipay.com.br
📖
Documentation
https://dev.efipay.com.br/docs/api-pix/credenciais
📖
APIReference
https://dev.efipay.com.br/docs/api-pix
📖
Documentation
https://dev.efipay.com.br/docs/open-finance
📖
Documentation
https://dev.efipay.com.br/docs/abertura-de-contas
📖
Documentation
https://dev.efipay.com.br/docs/api-pagamentos
📖
Documentation
https://dev.efipay.com.br/docs/extrato-cnab

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/gerencianet/refs/heads/main/openapi/gerencianet-subscriptions-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/gerencianet/refs/heads/main/json-schema/efi-cobrancas-charge-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/gerencianet/refs/heads/main/json-structure/efi-cobrancas-charge-structure.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/gerencianet/refs/heads/main/json-schema/efi-pix-cob-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/gerencianet/refs/heads/main/json-schema/efi-pix-pix-received-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/gerencianet/refs/heads/main/json-structure/efi-pix-cob-structure.json

Other Resources

🔗
BaseURL
https://cobrancas.api.efipay.com.br/v1
🔗
SandboxURL
https://cobrancas-h.api.efipay.com.br/v1
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/gerencianet/refs/heads/main/examples/efi-cobrancas-onestep-example.json
🔗
BaseURL
https://pix.api.efipay.com.br
🔗
SandboxURL
https://pix-h.api.efipay.com.br
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/gerencianet/refs/heads/main/examples/efi-pix-create-cob-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/gerencianet/refs/heads/main/examples/efi-pix-send-example.json
🔗
BaseURL
https://openfinance.api.efipay.com.br/v1
🔗
SandboxURL
https://openfinance-h.api.efipay.com.br/v1
🔗
BaseURL
https://abrircontas.api.efipay.com.br/v1
🔗
SandboxURL
https://abrircontas-h.api.efipay.com.br/v1
🔗
BaseURL
https://pagarcontas.api.efipay.com.br/v1
🔗
SandboxURL
https://pagarcontas-h.api.efipay.com.br/v1
🔗
BaseURL
https://extratos.api.efipay.com.br/v1
🔗
SandboxURL
https://extratos-h.api.efipay.com.br/v1

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/gerencianet:gerencianet-subscriptions-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

gerencianet-subscriptions-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Efí Pay Cobranças Subscriptions API
  description: Billing API for Efí Pay (formerly Gerencianet). Issue boletos (Brazilian bank slips), Bolix (next-business-day boletos), carnês (installment booklets), payment links, credit card charges, subscriptions/recurring billing, and marketplace payment splits. OAuth2 with HTTP Basic for client_credentials.
  version: '1.0'
  contact:
    name: Efí Pay Developer Support
    url: https://dev.efipay.com.br
  license:
    name: Proprietary
servers:
- url: https://cobrancas.api.efipay.com.br/v1
  description: Production
- url: https://cobrancas-h.api.efipay.com.br/v1
  description: Homologation (Sandbox)
security:
- oauth2ClientCredentials: []
tags:
- name: Subscriptions
paths:
  /plan/{id}/subscription:
    post:
      tags:
      - Subscriptions
      summary: Create Subscription
      operationId: createSubscription
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Subscription created
  /plan/{id}/subscription/one-step:
    post:
      tags:
      - Subscriptions
      summary: Create One Step Subscription
      operationId: createOneStepSubscription
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Subscription created
  /plan/{id}/subscription/one-step/link:
    post:
      tags:
      - Subscriptions
      summary: Create One Step Subscription Link
      operationId: createOneStepSubscriptionLink
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Link created
  /subscription/{id}:
    get:
      tags:
      - Subscriptions
      summary: Detail Subscription
      operationId: detailSubscription
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Subscription detail
    put:
      tags:
      - Subscriptions
      summary: Update Subscription
      operationId: updateSubscription
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Updated
  /subscription/{id}/pay:
    post:
      tags:
      - Subscriptions
      summary: Define Subscription Payment Method
      operationId: defineSubscriptionPayMethod
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Applied
  /subscription/{id}/cancel:
    put:
      tags:
      - Subscriptions
      summary: Cancel Subscription
      operationId: cancelSubscription
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Cancelled
  /subscription/{id}/metadata:
    put:
      tags:
      - Subscriptions
      summary: Update Subscription Metadata
      operationId: updateSubscriptionMetadata
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Updated
  /subscription/{id}/history:
    post:
      tags:
      - Subscriptions
      summary: Create Subscription History Note
      operationId: createSubscriptionHistory
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Note added
  /charge/{id}/subscription/resend:
    post:
      tags:
      - Subscriptions
      summary: Send Subscription Link Email
      operationId: sendSubscriptionLinkEmail
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Email queued
components:
  securitySchemes:
    oauth2ClientCredentials:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://cobrancas.api.efipay.com.br/v1/authorize
          scopes: {}