Efí Pay (Gerencianet)

Efí Pay (Gerencianet) Account API

The Account API from Efí Pay (Gerencianet) — 2 operation(s) for account.

GitHub OpenAPI

Operations 3

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

GET /v2/gn/saldo Check the account balance · Get Account Balance #
Ask an LLM
“What is the current balance in my Efí Pay account?”
“Can I see how much money is available in my Pix account right now?”
Tell an agent
Show my current account balance.
Tell me how much money is in my account.
GET /v2/gn/config View the account's Pix settings · List Account Config #
Ask an LLM
“Where can I see the settings configured on my Pix account?”
“Which account configuration options are currently in effect?”
Tell an agent
Show my account configuration.
List the current settings on my Pix account.
PUT /v2/gn/config Change the account's Pix settings · Update Account Config #
Ask an LLM
“Can I change the configuration of my Pix account through the API?”
“How do I update my account settings?”
Tell an agent
Update my account configuration.
Save new settings for my Pix account.

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-account-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
🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/gerencianet/refs/heads/main/apis.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/gerencianet/refs/heads/main/arazzo/gerencianet-account-onboarding-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/gerencianet/refs/heads/main/arazzo/gerencianet-account-webhook-setup-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/gerencianet/refs/heads/main/arazzo/gerencianet-bill-payment-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/gerencianet/refs/heads/main/arazzo/gerencianet-boleto-charge-issue-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/gerencianet/refs/heads/main/arazzo/gerencianet-card-charge-refund-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/gerencianet/refs/heads/main/arazzo/gerencianet-pix-charge-qrcode-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/gerencianet/refs/heads/main/arazzo/gerencianet-pix-charge-revise-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/gerencianet/refs/heads/main/arazzo/gerencianet-pix-charge-status-refund-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/gerencianet/refs/heads/main/arazzo/gerencianet-pix-due-charge-qrcode-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/gerencianet/refs/heads/main/arazzo/gerencianet-pix-send-cashout-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/gerencianet/refs/heads/main/arazzo/gerencianet-pix-webhook-setup-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/gerencianet/refs/heads/main/arazzo/gerencianet-statement-schedule-workflow.yml

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-account-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-account-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Efí Pay Pix Account API
  description: Brazilian Pix instant-payments API for Efí Pay (formerly Gerencianet). Implements the Banco Central do Brasil Pix specification (cob/cobv/cobr, locations, devolutions, Pix keys/EVP) plus Efí Pay extensions for Cash-Out (pixSend), splits, MED infractions, recurring/automatic Pix, statements, receipts, and webhooks. OAuth2 client_credentials with mandatory mutual TLS (P12/PEM certificate).
  version: '2.0'
  contact:
    name: Efí Pay Developer Support
    url: https://dev.efipay.com.br/docs/api-pix
  license:
    name: Proprietary
servers:
- url: https://pix.api.efipay.com.br
  description: Production
- url: https://pix-h.api.efipay.com.br
  description: Homologation (Sandbox)
security:
- oauth2Pix: []
tags:
- name: Account
paths:
  /v2/gn/saldo:
    get:
      tags:
      - Account
      summary: Get Account Balance
      operationId: getAccountBalance
      responses:
        '200':
          description: Balance
  /v2/gn/config:
    get:
      tags:
      - Account
      summary: List Account Config
      operationId: listAccountConfig
      responses:
        '200':
          description: Config
    put:
      tags:
      - Account
      summary: Update Account Config
      operationId: updateAccountConfig
      responses:
        '200':
          description: Updated
components:
  securitySchemes:
    oauth2Pix:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://pix.api.efipay.com.br/oauth/token
          scopes:
            cob.read: Read immediate charges
            cob.write: Create/update immediate charges
            cobv.read: Read due charges
            cobv.write: Create/update due charges
            pix.read: Read received Pix
            pix.write: Manage devolutions
            pix.send: Send Pix
            webhook.read: Read webhook config
            webhook.write: Configure webhooks
            gn.balance.read: Read account balance