Skip to main content
Glama
mcp-server-efi

mcp-server-efi

by JoaoLucasAl

Servidor MCP Efí

Servidor MCP oficial da Efí, executado via stdio, que disponibiliza as APIs da Efí pelo Model Context Protocol (MCP). Os contratos públicos acompanham as atualizações compatíveis do sdk-node-apis-efi 2.x; a documentação Efí é usada para redigir descrições úteis, sem alterar tipos ou validações do SDK.

Este é o repositório oficial do projeto e a origem dos pacotes publicados pela Efí.

Cobertura

O catálogo cobre e registra por padrão os 173 métodos. As três operações que devolvem certificado, credenciais ou chave privada aparecem na descoberta, mas sua execução exige opt-in explícito.

API

Endpoints HTTP

Operações locais

Cobranças

47

0

Pix

78

2

Open Finance

26

0

Pagamento de Contas

7

0

Abertura de Contas

7

0

Extratos

6

0

Os nomes das tools usam snake_case. A entrada mantém o envelope { params, body } apenas com as partes aplicáveis; mutações Open Finance compatíveis também aceitam idempotency_key. Quando ela é omitida, o servidor gera uma chave criptograficamente segura e a devolve no sucesso ou erro para permitir uma repetição consciente da mesma operação.

Related MCP server: Payments MCP

Requisitos

  • Node.js 22 ou superior.

  • Client ID e Client Secret de uma aplicação Efí para executar endpoints HTTP.

  • Certificado ao executar APIs mTLS.

O servidor pode iniciar, completar o handshake e apresentar seu catálogo sem credenciais. A configuração necessária é verificada somente quando uma tool realiza uma operação HTTP; chamadas locais de inspeção e geração de QR Code Pix continuam disponíveis.

Credenciais e execução pela CLI

Credenciais são opcionais no startup e não são aceitas em argumentos da linha de comando, pois argumentos podem aparecer no histórico do shell e na lista de processos. Crie um arquivo local .env.efi, mantenha-o fora do controle de versão e restrinja sua leitura:

EFI_CLIENT_ID=seu_client_id
EFI_CLIENT_SECRET=seu_client_secret
EFI_SANDBOX=true
EFI_CERTIFICATE=/caminho/absoluto/certificado.p12
chmod 600 .env.efi

Para executar o pacote com npx, carregue o arquivo somente no ambiente do processo:

set -a
. ./.env.efi
set +a
npx -y mcp-server-efi --apis=pix,open-finance

Sem --apis, os seis domínios são habilitados. Os valores aceitos são cobrancas, pix, open-finance, pagamento-contas, abertura-contas e extratos.

Configuração

Somente opções não secretas possuem flags. Sua precedência é CLI > EFI_* > variável legada:

CLI

Ambiente EFI_*

Legada

Padrão

--sandbox

EFI_SANDBOX

SANDBOX

true

--apis

EFI_APIS

APIS

todas

--cert-base64

EFI_CERT_BASE64

CERT_BASE64

true

--validate-mtls

EFI_VALIDATE_MTLS

VALIDATE_MTLS

true

--cache

EFI_CACHE

CACHE

true

-h, --help

—

—

—

Booleanos aceitam true, false, 1 e 0.

O mTLS é usado na comunicação com os endpoints que recebem webhooks compatíveis. A opção validate-mtls deve permanecer em true para manter essa proteção; quando definida como false, o SDK envia o bypass de validação somente durante a configuração do webhook. Por segurança, não recomendamos desabilitá-la.

Material de autenticação e valores sensíveis são aceitos exclusivamente pelas seguintes variáveis, sem flags ou aliases sem o prefixo EFI_:

Variável

Destino no SDK

Obrigatoriedade

EFI_CLIENT_ID

client_id

em chamadas HTTP

EFI_CLIENT_SECRET

client_secret

em chamadas HTTP

EFI_CERTIFICATE

certificate

na chamada de uma API mTLS

EFI_PEM_KEY

pemKey

certificado PEM com chave separada

EFI_PARTNER_TOKEN

partner_token

somente integrações compatíveis

Não existe chave global de idempotência: cada uma das 17 mutações Open Finance recebe a chave explícita da chamada ou uma nova chave alfanumérica de 72 caracteres. Valores vazios e CR/LF são rejeitados.

Saídas sensíveis

Estas tools aparecem em tools/list, mas sua execução é bloqueada por padrão:

  • create_account_certificate

  • get_account_credentials

  • create_sftp_key

Para autorizar somente as necessárias, configure simultaneamente:

EFI_SENSITIVE_TOOLS=create_account_certificate,get_account_credentials
EFI_ACCEPT_SENSITIVE_OUTPUT_RISK=I_UNDERSTAND

Não são aceitos *, all, aliases, flags de CLI ou confirmação dentro de uma chamada MCP. Uma seleção incompleta, desconhecida ou pertencente a uma API desabilitada impede a inicialização.

Contenção

O processo rejeita excesso de chamadas imediatamente, sem criar fila nem chamar o SDK. O resultado usa isError: true, rate_limit_exceeded e retry_after_ms.

Variável

Padrão

EFI_MAX_CONCURRENCY

4

EFI_MUTATION_MAX_CONCURRENCY

1

EFI_READ_RATE_PER_MINUTE

60

EFI_MUTATION_RATE_PER_MINUTE

10

EFI_SENSITIVE_RATE_PER_MINUTE

1

Configuração de um host MCP

Clientes MCP que iniciam servidores stdio normalmente fornecem as credenciais pelo campo env do subprocesso. Essa é a orientação da especificação de autorização MCP para servidores locais. Ajuste caminhos e valores conforme o cliente:

{
  "mcpServers": {
    "mcp-server-efi": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-server-efi",
        "--sandbox=true",
        "--apis=pix,open-finance",
        "--cert-base64=false"
      ],
      "env": {
        "EFI_CLIENT_ID": "seu_client_id",
        "EFI_CLIENT_SECRET": "seu_client_secret",
        "EFI_CERTIFICATE": "/caminho/absoluto/certificado.p12"
      }
    }
  }
}

Se o host oferecer keychain, cofre ou substituição segura de segredos, prefira esse recurso a valores literais no arquivo de configuração. O exemplo completo do repositório está em mcp.jsonc.

Docker

A imagem usa Node 22, build em múltiplos estágios e processo final sem privilégios de root. NPM, Corepack e Yarn são removidos da camada final depois da instalação: o runtime contém o executável node e as dependências de produção, mas não inclui um gerenciador de pacotes.

docker pull ghcr.io/efipay/mcp-server-efi:1.0.2

docker run -i --rm \
  --env-file .env.efi \
  --mount type=bind,source=/caminho/absoluto/certificado.p12,target=/run/secrets/efi.p12,readonly \
  --env EFI_CERTIFICATE=/run/secrets/efi.p12 \
  ghcr.io/efipay/mcp-server-efi:1.0.2 \
  --apis=pix,open-finance

O bind mount torna o caminho do certificado válido dentro do contêiner; ele deve ser legível pelo usuário node. Como alternativa, grave o certificado em base64 no arquivo de ambiente e use EFI_CERT_BASE64=true, sem mount.

Instalação via Smithery e MCPB

Na página oficial do servidor no Smithery, o servidor é fornecido como MCP Bundle e executado localmente via stdio, sem uma URL pública. O manifesto MCPB 0.3 marca credenciais e certificados como configurações sensíveis e os encaminha ao processo por EFI_*, nunca por args.

O MCPB aceita configuração vazia e apresenta as 173 tools dos seis domínios. Credenciais e certificado podem ser adicionados pela interface segura do cliente antes de executar os endpoints correspondentes.

Contratos e respostas MCP

  • params, body e respostas usam os schemas Zod 4 exportados pelo SDK oficial.

  • Respostas JSON são fornecidas como texto e em structuredContent.result.

  • Operações sem conteúdo retornam { "success": true }.

  • Comprovantes Pix retornam a URI e o identificador em structuredContent.result e mantêm o conteúdo binário somente no recurso PDF embutido; QR Codes podem incluir conteúdo de imagem.

  • pix_qr_code_detail preserva o JWS obtido pelo mesmo decoder usado no SDK, exige que jku tenha a mesma origem do payload acessado e verifica a assinatura com o kid do JWKS. Estados invalid e unavailable são alertas e não autorizam pagamento.

  • Falhas de validação ou da Efí retornam isError: true, com dados sensíveis sanitizados.

  • stdout é reservado ao protocolo; mensagens operacionais são escritas em stderr.

Segurança e atualização

  • Não são aceitos headers arbitrários nas tools.

  • Não registre credenciais, tokens, certificados ou conteúdo PEM em arquivos versionados ou logs.

  • Mantenha validate-mtls=true; o mTLS protege a comunicação dos webhooks compatíveis e, por segurança, não recomendamos desabilitá-lo.

  • Consulte a política de segurança para comunicar vulnerabilidades.

  • Consulte MIGRATION.md antes de migrar de versões 0.x.

Available Tools

173 tools
account_config_webhookConfigurar webhook de abertura de contasA
Destructive

Cria ou atualiza uma configuração de webhook para eventos de abertura de contas. Use após preparar o endpoint com a segurança exigida para acompanhar o onboarding.

Inputs: body (required). Returns: Resultado estruturado retornado pela tool account_config_webhook.

account_delete_webhookCancelar webhook de abertura de contasA
DestructiveIdempotent

Cancela uma configuração de webhook de abertura de contas pelo identificador. Use quando o destino não deve mais receber eventos; os callbacks correspondentes serão interrompidos.

Inputs: params (required). Returns: Resultado estruturado retornado pela tool account_delete_webhook.

account_detail_webhookConsultar webhook de abertura de contasA
Read-onlyIdempotent

Consulta uma configuração de webhook de abertura de contas pelo identificador. Use para confirmar URL e data de criação sem modificar o recebimento de eventos.

Inputs: params (required). Returns: Resultado estruturado retornado pela tool account_detail_webhook.

account_list_webhookListar webhooks de abertura de contasA
Read-onlyIdempotent

Lista configurações de webhook de abertura de contas conforme os filtros aceitos. Use para inventariar destinos de onboarding e localizar uma configuração sem alterá-la.

Inputs: params (required). Returns: Resultado estruturado retornado pela tool account_list_webhook.

cancel_carnetCancelar um carnêA
DestructiveIdempotent

Cancela um carnê existente e as cobranças abrangidas pela operação conforme o estado aceito pela Efí. Use quando o conjunto de parcelas não deve mais ser cobrado.

Inputs: params (required). Returns: Resultado estruturado retornado pela tool cancel_carnet.

cancel_carnet_parcelCancelar uma parcela de carnêA
DestructiveIdempotent

Cancela uma parcela específica de um carnê sem cancelar necessariamente as demais. Use quando somente aquele vencimento não deve mais ser cobrado do pagador.

Inputs: params (required). Returns: Resultado estruturado retornado pela tool cancel_carnet_parcel.

cancel_chargeCancelar uma cobrançaA
DestructiveIdempotent

Cancela uma cobrança existente que ainda possa ser cancelada. Use quando o débito não deve mais ser cobrado; a mudança de estado impede que o fluxo de pagamento prossiga normalmente.

Inputs: params (required). Returns: Resultado estruturado retornado pela tool cancel_charge.

cancel_subscriptionCancelar uma assinaturaA
DestructiveIdempotent

Cancela uma assinatura ativa e interrompe seu fluxo normal de cobranças futuras. Use quando o cliente não deve mais permanecer vinculado à recorrência do plano.

Inputs: params (required). Returns: Resultado estruturado retornado pela tool cancel_subscription.

card_payment_retryTentar novamente pagamento com cartãoA
Destructive

Solicita nova tentativa de pagamento por cartão para uma cobrança compatível. Use após uma tentativa não autorizada e com dados válidos; a operação pode efetivar a cobrança do cliente.

Inputs: body (required), params (required). Returns: Resultado estruturado retornado pela tool card_payment_retry.

create_accountSolicitar abertura de conta simplificadaA

Inicia a abertura de uma conta Efí para o cliente final com os dados e acessos informados. Use no onboarding; o cliente deverá autorizar a integração recebida por mensagem.

Inputs: body (required). Returns: Resultado estruturado retornado pela tool create_account.

create_account_certificateCriar certificado de conta simplificadaA

Gera o certificado de integração de uma conta simplificada já criada. Use após a conta estar apta; a resposta contém material P12 em base64 e deve ser tratada como segredo.

Inputs: params (required). Returns: Resultado estruturado retornado pela tool create_account_certificate.

create_carnetCriar carnê de cobrançasB

Cria um carnê com várias parcelas e vencimentos para o mesmo pagador. Use quando a venda exigir cobranças periódicas já definidas em lote; cada parcela poderá ser acompanhada separadamente.

Inputs: body (required). Returns: Resultado estruturado retornado pela tool create_carnet.

create_carnet_historyAdicionar histórico a um carnêA

Acrescenta uma descrição ao histórico de um carnê existente. Use para registrar uma ocorrência operacional sem modificar vencimentos, valores ou situação das parcelas.

Inputs: body (required), params (required). Returns: Resultado estruturado retornado pela tool create_carnet_history.

create_chargeCriar transação de cobrançaA

Cria a transação inicial de uma cobrança sem concluir a escolha da forma de pagamento. Use no fluxo em duas etapas, antes de associar boleto, cartão ou link à transação.

Inputs: body (required). Returns: Resultado estruturado retornado pela tool create_charge.

create_charge_cardCriar cobrança por cartãoB
Destructive

Cria e submete uma cobrança por cartão de crédito pela versão atual da rota de cartões. Use quando o token de pagamento e os dados exigidos já estiverem disponíveis; pode cobrar o cliente.

Inputs: body (required). Returns: Resultado estruturado retornado pela tool create_charge_card.

create_charge_historyAdicionar histórico a uma cobrançaA

Acrescenta uma descrição ao histórico de uma cobrança existente. Use para registrar uma ocorrência operacional ou observação sem alterar valor, vencimento ou estado de pagamento.

Inputs: body (required), params (required). Returns: Resultado estruturado retornado pela tool create_charge_history.

create_one_step_chargeCriar cobrança em uma etapaA
Destructive

Cria a transação e sua forma de pagamento em uma única operação. Use quando todos os dados comerciais e do pagador já estiverem disponíveis para emitir a cobrança imediatamente.

Inputs: body (required). Returns: Resultado estruturado retornado pela tool create_one_step_charge.

create_one_step_subscriptionCriar assinatura com pagamento em uma etapaA
Destructive

Cria a assinatura e define sua forma de pagamento em uma única operação. Use quando plano, assinante e dados de pagamento já estiverem disponíveis para iniciar a recorrência.

Inputs: body (required), params (required). Returns: Resultado estruturado retornado pela tool create_one_step_subscription.

create_planCriar plano de assinaturaA

Cria um plano que define a periodicidade e a quantidade de cobranças recorrentes. Use antes de vincular clientes a assinaturas que deverão seguir a mesma programação.

Inputs: body (required). Returns: Resultado estruturado retornado pela tool create_plan.

create_reportSolicitar relatório de conciliação PixA

Solicita a geração assíncrona de um relatório de conciliação Pix. Use quando precisar consolidar movimentações para conferência; a resposta identifica o processamento a acompanhar.

Inputs: body (required). Returns: Resultado estruturado retornado pela tool create_report.

create_sftp_keyGerar chave privada para extratos via SFTPA
Destructive

Gera a chave privada associada à conta para integração de extratos por SFTP. Use ao configurar essa forma de entrega e proteja a resposta, pois contém uma chave privada sensível.

Inputs: no named parameters. Returns: Resultado estruturado retornado pela tool create_sftp_key.

create_statement_recurrencyCriar recorrência de extrato CNAB 240A

Cria um agendamento recorrente para gerar extratos CNAB 240 e disponibilizá-los conforme a configuração informada. Use para automatizar a conciliação periódica.

Inputs: body (required). Returns: Resultado estruturado retornado pela tool create_statement_recurrency.

create_subscriptionCriar assinatura em um planoA

Cria uma assinatura vinculada a um plano já existente, ainda sem concluir a forma de pagamento. Use no fluxo em duas etapas antes de associar os dados de cobrança do assinante.

Inputs: body (required), params (required). Returns: Resultado estruturado retornado pela tool create_subscription.

create_subscription_historyAdicionar histórico a uma assinaturaA

Acrescenta uma descrição ao histórico de uma assinatura. Use para registrar uma ocorrência operacional sem alterar o plano, a forma de pagamento ou seu estado.

Inputs: body (required), params (required). Returns: Resultado estruturado retornado pela tool create_subscription_history.

define_balance_sheet_billetDefinir boleto do tipo balanceteA
Destructive

Define que a cobrança previamente criada produzirá um boleto balancete e informa seu conteúdo tabular. Use quando o documento precisar desse layout; a Efí apenas organiza os dados fornecidos.

Inputs: body (required), params (required). Returns: Resultado estruturado retornado pela tool define_balance_sheet_billet.

define_pay_methodDefinir forma de pagamento de uma cobrançaB
Destructive

Associa uma forma de pagamento e os dados do pagador a uma transação previamente criada. Use para concluir a segunda etapa da cobrança e gerar o instrumento de pagamento correspondente.

Inputs: body (required), params (required). Returns: Resultado estruturado retornado pela tool define_pay_method.

define_subscription_pay_methodDefinir forma de pagamento da assinaturaA
Destructive

Associa a forma de pagamento e os dados do cliente a uma assinatura previamente criada. Use para concluir a segunda etapa e habilitar as cobranças recorrentes do plano.

Inputs: body (required), params (required). Returns: Resultado estruturado retornado pela tool define_subscription_pay_method.

delete_planExcluir plano de assinaturaA
DestructiveIdempotent

Exclui um plano de assinatura existente quando a Efí permitir a remoção. Use apenas se o plano não deve mais receber novas assinaturas, pois a operação remove sua configuração.

Inputs: params (required). Returns: Resultado estruturado retornado pela tool delete_plan.

detail_carnetConsultar um carnêA
Read-onlyIdempotent

Consulta um carnê existente e a situação de suas parcelas. Use para acompanhar vencimentos, pagamentos, baixas e cancelamentos sem realizar qualquer alteração no carnê.

Inputs: params (required). Returns: Resultado estruturado retornado pela tool detail_carnet.

detail_chargeConsultar uma cobrançaA
Read-onlyIdempotent

Consulta os dados atuais de uma cobrança, incluindo sua forma de pagamento e situação. Use para acompanhar processamento, pagamento ou cancelamento sem modificar a transação.

Inputs: params (required). Returns: Resultado estruturado retornado pela tool detail_charge.

detail_reportConsultar relatório de conciliação PixA
Read-onlyIdempotent

Consulta o estado e os dados de um relatório de conciliação solicitado anteriormente. Use para verificar se o processamento terminou e obter as informações disponibilizadas pela Efí.

Inputs: params (required). Returns: Resultado estruturado retornado pela tool detail_report.

detail_subscriptionConsultar uma assinaturaA
Read-onlyIdempotent

Consulta os dados e a situação atual de uma assinatura vinculada a um plano. Use para acompanhar cobranças recorrentes, pagamento ou cancelamento sem alterar a assinatura.

Inputs: params (required). Returns: Resultado estruturado retornado pela tool detail_subscription.

get_account_balanceConsultar saldo da conta PixA
Read-onlyIdempotent

Consulta o saldo disponível da conta Efí e, quando solicitado, os valores bloqueados. Use antes de operações de saída ou em conciliações; nenhum saldo é movimentado.

Inputs: params. Returns: Resultado estruturado retornado pela tool get_account_balance.

get_account_credentialsObter credenciais de conta simplificadaA
Read-onlyIdempotent

Recupera Client ID, Client Secret e dados de integração de uma conta simplificada. Use após a aprovação da conta e proteja a resposta, pois ela contém credenciais sensíveis.

Inputs: params (required). Returns: Resultado estruturado retornado pela tool get_account_credentials.

get_installmentsConsultar opções de parcelamento no cartãoA
Read-onlyIdempotent

Consulta as opções e valores de parcelamento disponíveis para uma bandeira de cartão. Use antes de apresentar as parcelas ao cliente ou de criar a cobrança por cartão.

Inputs: params (required). Returns: Resultado estruturado retornado pela tool get_installments.

get_notificationConsultar uma notificação de cobrançaA
Read-onlyIdempotent

Recupera, pelo token recebido no callback, os eventos e dados atualizados associados a uma notificação. Use após a Efí avisar uma mudança para confirmar o estado da transação correspondente.

Inputs: params (required). Returns: Resultado estruturado retornado pela tool get_notification.

get_statement_fileBaixar arquivo de extrato CNAB 240A
Read-onlyIdempotent

Recupera pelo nome um arquivo de extrato CNAB 240 previamente gerado. Use para importar movimentos em uma rotina de conciliação sem alterar a conta ou o agendamento.

Inputs: params (required). Returns: Resultado estruturado retornado pela tool get_statement_file.

list_account_configConsultar configurações da conta PixA
Read-onlyIdempotent

Retorna as regras Pix definidas para a conta e suas chaves. Use para conferir comportamento de recebimento e notificações antes de alterá-lo.

Inputs: no named parameters. Returns: Resultado estruturado retornado pela tool list_account_config.

list_chargesListar cobrançasA
Read-onlyIdempotent

Lista cobranças conforme os filtros aceitos pela Efí. Use para conciliação, acompanhamento operacional ou localização de transações sem modificar seus estados.

Inputs: params (required). Returns: Resultado estruturado retornado pela tool list_charges.

list_plansListar planos de assinaturaA
Read-onlyIdempotent

Lista os planos de assinatura cadastrados e seus dados de recorrência. Use para localizar o plano adequado antes de criar uma assinatura ou para consultar a configuração vigente.

Inputs: params. Returns: Resultado estruturado retornado pela tool list_plans.

list_statement_filesListar arquivos de extrato CNAB 240A
Read-onlyIdempotent

Lista os arquivos de extrato CNAB 240 já gerados para a conta. Use para localizar períodos disponíveis para conciliação antes de solicitar o download de um arquivo.

Inputs: no named parameters. Returns: Resultado estruturado retornado pela tool list_statement_files.

list_statement_recurrencesListar recorrências de extrato CNAB 240A
Read-onlyIdempotent

Lista os agendamentos recorrentes de geração de extrato CNAB 240 cadastrados na conta. Use para verificar frequência e entrega antes de criar ou revisar uma recorrência.

Inputs: no named parameters. Returns: Resultado estruturado retornado pela tool list_statement_recurrences.

med_defenseSubmeter defesa de infração MEDA
Destructive

Envia uma defesa para uma infração específica do Mecanismo Especial de Devolução. Use para complementar a análise; o envio não substitui o acompanhamento e documentos solicitados por ticket.

Inputs: body (required), params (required). Returns: Resultado estruturado retornado pela tool med_defense.

med_listListar infrações MEDA
Read-onlyIdempotent

Lista infrações MED abertas nas contas associadas ao documento da conta autenticada. Use para acompanhar contestações e identificar casos que exigem defesa ou tratativa adicional.

Inputs: params. Returns: Resultado estruturado retornado pela tool med_list.

of_cancel_automatic_pix_paymentCancelar pagamento Pix automático do Open FinanceA
Destructive

Solicita o cancelamento de um pagamento Pix automático quando seu estado permitir. Use para impedir uma execução pendente; a adesão deve ser tratada separadamente se também precisar mudar.

Inputs: body (required), idempotency_key. Returns: Resultado estruturado retornado pela tool of_cancel_automatic_pix_payment.

of_cancel_recurrency_pixCancelar pagamento Pix recorrente do Open FinanceA
Destructive

Cancela uma recorrência Pix iniciada via Open Finance quando seu estado permitir. Use para impedir as execuções futuras da série; pagamentos já concluídos não são uma nova iniciação.

Inputs: params (required), idempotency_key. Returns: Resultado estruturado retornado pela tool of_cancel_recurrency_pix.

of_cancel_schedule_pixCancelar pagamento Pix agendado do Open FinanceA
Destructive

Cancela um pagamento Pix agendado iniciado via Open Finance quando seu estado permitir. Use antes da execução para impedir a movimentação prevista.

Inputs: params (required), idempotency_key. Returns: Resultado estruturado retornado pela tool of_cancel_schedule_pix.

of_config_detailConsultar configuração da aplicação Open FinanceA
Read-onlyIdempotent

Consulta as URLs atualmente configuradas para redirecionamentos e callbacks Open Finance. Use para validar a integração antes de iniciar uma jornada de pagamento.

Inputs: no named parameters. Returns: Resultado estruturado retornado pela tool of_config_detail.

of_config_updateAtualizar URLs da aplicação Open FinanceA
DestructiveIdempotent

Configura as URLs usadas nos redirecionamentos e callbacks das jornadas Open Finance. Use antes de iniciar pagamentos e somente com destinos preparados para receber o fluxo.

Inputs: body (required), idempotency_key. Returns: Resultado estruturado retornado pela tool of_config_update.

of_create_automatic_enrollmentCriar adesão a pagamento automático Open FinanceA

Solicita a criação de uma adesão para pagamentos automáticos via Open Finance. Use antes de iniciar pagamentos dessa modalidade; a adesão deverá seguir sua jornada de autorização.

Inputs: body (required), idempotency_key. Returns: Resultado estruturado retornado pela tool of_create_automatic_enrollment.

of_create_automatic_pix_paymentCriar pagamento Pix automático via Open FinanceA
Destructive

Solicita um pagamento Pix apoiado por uma adesão automática previamente autorizada. Use após validar adesão, recebedor e valor; a operação pode movimentar recursos.

Inputs: body (required), idempotency_key. Returns: Resultado estruturado retornado pela tool of_create_automatic_pix_payment.

of_create_biometric_enrollmentCriar vínculo biométrico Open FinanceA

Cria o vínculo de dispositivo ou credencial necessário à jornada de pagamento por biometria. Use durante a adesão do usuário, antes de iniciar pagamentos sem redirecionamento.

Inputs: body (required), idempotency_key. Returns: Resultado estruturado retornado pela tool of_create_biometric_enrollment.

of_create_biometric_pix_paymentCriar pagamento Pix por biometriaA
Destructive

Solicita um pagamento Pix pela jornada biométrica sem redirecionamento. Use somente com vínculo previamente criado e após conferir recebedor e valor; pode movimentar recursos.

Inputs: body (required), idempotency_key. Returns: Resultado estruturado retornado pela tool of_create_biometric_pix_payment.

of_devolution_pixDevolver pagamento Pix do Open FinanceA
Destructive

Solicita a devolução de um pagamento Pix imediato iniciado via Open Finance. Use após localizar e conferir o pagamento concluído, pois a operação movimenta valores.

Inputs: body (required), params (required), idempotency_key. Returns: Resultado estruturado retornado pela tool of_devolution_pix.

of_devolution_recurrency_pixDevolver parcela Pix recorrente do Open FinanceA
Destructive

Solicita a devolução de um pagamento executado dentro de uma recorrência Open Finance. Use após identificar a parcela e conferir o valor, pois há movimentação de recursos.

Inputs: body (required), params (required), idempotency_key. Returns: Resultado estruturado retornado pela tool of_devolution_recurrency_pix.

of_devolution_schedule_pixDevolver pagamento Pix agendado do Open FinanceA
Destructive

Solicita a devolução de um pagamento Pix agendado que já foi executado. Use após conferir o pagamento e o valor devolvido, pois a operação movimenta recursos.

Inputs: body (required), params (required), idempotency_key. Returns: Resultado estruturado retornado pela tool of_devolution_schedule_pix.

of_list_automatic_enrollmentConsultar adesões de pagamento automáticoA
Read-onlyIdempotent

Consulta os parâmetros e a situação de adesões de pagamento automático Open Finance. Use para verificar a autorização disponível antes de iniciar uma cobrança automática.

Inputs: params (required). Returns: Resultado estruturado retornado pela tool of_list_automatic_enrollment.

of_list_automatic_pix_paymentListar pagamentos Pix automáticos do Open FinanceA
Read-onlyIdempotent

Lista pagamentos Pix realizados por adesões automáticas conforme os filtros aceitos. Use para acompanhar processamento e conciliação sem criar outro pagamento.

Inputs: params (required). Returns: Resultado estruturado retornado pela tool of_list_automatic_pix_payment.

of_list_biometric_enrollmentConsultar vínculos biométricos Open FinanceA
Read-onlyIdempotent

Lista os vínculos biométricos de um usuário conforme os filtros informados. Use para confirmar se existe vínculo apto antes de iniciar pagamento sem redirecionamento.

Inputs: params (required). Returns: Resultado estruturado retornado pela tool of_list_biometric_enrollment.

of_list_biometric_pix_paymentListar pagamentos Pix por biometriaA
Read-onlyIdempotent

Lista pagamentos Pix realizados pela jornada biométrica sem redirecionamento. Use para acompanhar processamento e conciliar operações sem iniciar outro pagamento.

Inputs: params (required). Returns: Resultado estruturado retornado pela tool of_list_biometric_pix_payment.

of_list_participantsListar instituições participantes do Open FinanceA
Read-onlyIdempotent

Lista instituições disponíveis para jornadas de iniciação de pagamento Open Finance. Use para o pagador escolher onde autorizar a operação antes de iniciar um Pix.

Inputs: params. Returns: Resultado estruturado retornado pela tool of_list_participants.

of_list_pix_paymentListar pagamentos Pix imediatos do Open FinanceA
Read-onlyIdempotent

Lista pagamentos Pix imediatos iniciados via Open Finance conforme período e filtros. Use para acompanhar autorização, conclusão ou falha sem criar novo pagamento.

Inputs: params (required). Returns: Resultado estruturado retornado pela tool of_list_pix_payment.

of_list_recurrency_pix_paymentListar pagamentos Pix recorrentes do Open FinanceA
Read-onlyIdempotent

Lista recorrências e pagamentos Pix iniciados via Open Finance conforme os filtros. Use para acompanhar a série e suas parcelas sem modificar a programação.

Inputs: params (required). Returns: Resultado estruturado retornado pela tool of_list_recurrency_pix_payment.

of_list_schedule_pix_paymentListar pagamentos Pix agendados do Open FinanceA
Read-onlyIdempotent

Lista pagamentos Pix agendados via Open Finance conforme período e filtros. Use para acompanhar autorização, agendamento e execução sem alterar os pagamentos.

Inputs: params (required). Returns: Resultado estruturado retornado pela tool of_list_schedule_pix_payment.

of_replace_recurrency_pix_parcelSubstituir parcela Pix recorrente do Open FinanceA
Destructive

Substitui uma parcela identificada dentro de uma recorrência Pix do Open Finance. Use quando a programação daquela parcela precisar ser revista; a operação altera uma execução financeira futura.

Inputs: body (required), params (required), idempotency_key. Returns: Resultado estruturado retornado pela tool of_replace_recurrency_pix_parcel.

of_revoke_biometric_enrollmentRevogar vínculo biométrico Open FinanceA
Destructive

Revoga um vínculo usado na jornada de pagamento por biometria. Use quando o dispositivo ou a autorização não deve mais permitir pagamentos sem redirecionamento.

Inputs: body (required), idempotency_key. Returns: Resultado estruturado retornado pela tool of_revoke_biometric_enrollment.

of_start_pix_paymentIniciar pagamento Pix via Open FinanceA
Destructive

Solicita a iniciação de um Pix imediato via Open Finance e produz a jornada de autorização correspondente. Use após definir o pagamento; sua conclusão pode movimentar valores.

Inputs: body (required), idempotency_key. Returns: Resultado estruturado retornado pela tool of_start_pix_payment.

of_start_recurrency_pix_paymentIniciar pagamento Pix recorrente via Open FinanceB
Destructive

Solicita a iniciação de uma série de pagamentos Pix recorrentes via Open Finance. Use para criar a jornada de autorização de pagamentos programados que poderão movimentar valores.

Inputs: body (required), idempotency_key. Returns: Resultado estruturado retornado pela tool of_start_recurrency_pix_payment.

of_start_schedule_pix_paymentIniciar pagamento Pix agendado via Open FinanceA
Destructive

Solicita a iniciação de um Pix para data futura via Open Finance e produz sua jornada de autorização. Use quando o pagamento deve ocorrer posteriormente; sua execução movimentará valores.

Inputs: body (required), idempotency_key. Returns: Resultado estruturado retornado pela tool of_start_schedule_pix_payment.

of_update_automatic_enrollmentAtualizar adesão de pagamento automáticoA
Destructive

Edita os dados permitidos de uma adesão de pagamento automático Open Finance. Use para revisar a autorização existente; a mudança pode afetar pagamentos automáticos futuros.

Inputs: body (required), idempotency_key. Returns: Resultado estruturado retornado pela tool of_update_automatic_enrollment.

pay_config_webhookConfigurar webhook de pagamentos de contasA
DestructiveIdempotent

Configura a URL que receberá atualizações sobre pagamentos de contas. Use após preparar o endpoint de callback seguro para acompanhar mudanças de estado.

Inputs: body (required). Returns: Resultado estruturado retornado pela tool pay_config_webhook.

pay_delete_webhookRemover webhook de pagamentos de contasA
DestructiveIdempotent

Remove a configuração de webhook de pagamentos de contas. Use quando o destino não deve mais receber atualizações; a aplicação deixará de receber os callbacks correspondentes.

Inputs: body (required). Returns: Resultado estruturado retornado pela tool pay_delete_webhook.

pay_detail_bar_codeDetalhar código de barras para pagamentoA
Read-onlyIdempotent

Consulta e valida os dados representados por um código de barras antes do pagamento. Use para apresentar beneficiário, vencimento e valor ao usuário sem movimentar saldo.

Inputs: params (required). Returns: Resultado estruturado retornado pela tool pay_detail_bar_code.

pay_detail_paymentConsultar pagamento de contaA
Read-onlyIdempotent

Consulta uma solicitação de pagamento de conta pelo identificador. Use para acompanhar processamento, confirmação ou falha sem repetir a ordem de pagamento.

Inputs: params (required). Returns: Resultado estruturado retornado pela tool pay_detail_payment.

pay_list_paymentsListar pagamentos de contasA
Read-onlyIdempotent

Lista um resumo das solicitações de pagamento conforme os filtros aceitos. Use para acompanhamento e conciliação das saídas sem iniciar novos pagamentos.

Inputs: params (required). Returns: Resultado estruturado retornado pela tool pay_list_payments.

pay_list_webhookConsultar webhook de pagamentos de contasA
Read-onlyIdempotent

Consulta a configuração de webhook usada nas notificações de pagamentos de contas. Use para confirmar o destino dos callbacks sem modificar sua entrega.

Inputs: params (required). Returns: Resultado estruturado retornado pela tool pay_list_webhook.

pay_request_bar_codeSolicitar pagamento de código de barrasA
Destructive

Solicita o pagamento de uma conta identificada por código de barras. Use somente depois de consultar e conferir os dados do título, pois a operação pode movimentar saldo.

Inputs: body (required), params (required). Returns: Resultado estruturado retornado pela tool pay_request_bar_code.

pix_config_webhookConfigurar webhook de uma chave PixA
DestructiveIdempotent

Configura a URL que receberá eventos Pix associados a uma chave. Use depois de preparar o endpoint de callback com os requisitos de segurança; a configuração substitui o destino aplicável.

Inputs: body (required), params (required). Returns: Resultado estruturado retornado pela tool pix_config_webhook.

pix_config_webhook_automatic_chargeConfigurar webhook de cobranças Pix AutomáticoA
DestructiveIdempotent

Configura a URL que receberá eventos das cobranças associadas a Pix Automático. Use depois de preparar o callback seguro para acompanhar tentativas e pagamentos recorrentes.

Inputs: body (required). Returns: Resultado estruturado retornado pela tool pix_config_webhook_automatic_charge.

pix_config_webhook_recurrence_automaticConfigurar webhook de recorrências Pix AutomáticoA
DestructiveIdempotent

Configura a URL que receberá eventos das recorrências de Pix Automático. Use depois de preparar o callback seguro; a operação define o destino das notificações desse recurso.

Inputs: body (required). Returns: Resultado estruturado retornado pela tool pix_config_webhook_recurrence_automat…

pix_create_automatic_chargeCriar cobrança Pix Automático sem txidA

Cria uma cobrança de Pix Automático e deixa a Efí atribuir o txid. Use para cobrar uma recorrência estabelecida quando a aplicação não precisar escolher o identificador.

Inputs: body (required). Returns: Resultado estruturado retornado pela tool pix_create_automatic_charge.

pix_create_automatic_charge_txidCriar cobrança Pix Automático com txidA
Idempotent

Cria uma cobrança vinculada a uma recorrência de Pix Automático usando txid definido pelo recebedor. Use para programar a cobrança de um acordo recorrente já estabelecido.

Inputs: body (required), params (required). Returns: Resultado estruturado retornado pela tool pix_create_automatic_charge_txid.

pix_create_chargeCriar cobrança Pix imediata com txidA
Idempotent

Cria uma cobrança Pix imediata com txid definido pelo recebedor. Use quando a aplicação precisar controlar o identificador e gerar um pagamento Pix rastreável.

Inputs: body (required), params (required). Returns: Resultado estruturado retornado pela tool pix_create_charge.

pix_create_due_chargeCriar cobrança Pix com vencimentoA
Idempotent

Cria uma cobrança Pix com vencimento usando um txid definido pelo recebedor. Use quando a cobrança precisar de data de vencimento e das regras financeiras admitidas para cobranças desse tipo.

Inputs: body (required), params (required). Returns: Resultado estruturado retornado pela tool pix_create_due_charge.

pix_create_due_charge_batchCriar ou substituir lote de cobranças PixA
Idempotent

Cria ou substitui um lote de cobranças Pix com vencimento sob um identificador. Use para registrar várias cobranças coordenadas; a operação altera o conteúdo integral do lote.

Inputs: body (required), params (required). Returns: Resultado estruturado retornado pela tool pix_create_due_charge_batch.

pix_create_evpCriar chave Pix aleatóriaA

Registra uma nova chave Pix aleatória na conta autenticada. Use quando a conta precisar de uma EVP para receber pagamentos; a resposta contém a chave criada.

Inputs: no named parameters. Returns: Resultado estruturado retornado pela tool pix_create_evp.

pix_create_immediate_chargeCriar cobrança Pix imediata sem txidA

Cria uma cobrança Pix imediata e deixa a Efí atribuir o txid. Use quando a aplicação não precisar escolher previamente o identificador da cobrança.

Inputs: body (required). Returns: Resultado estruturado retornado pela tool pix_create_immediate_charge.

pix_create_locationCriar location para payload PixA

Cria uma location reutilizável para associar uma cobrança a um payload dinâmico. Use antes de gerar o QR Code quando a aplicação precisar administrar essa associação separadamente.

Inputs: body (required). Returns: Resultado estruturado retornado pela tool pix_create_location.

pix_create_location_recurrence_automaticCriar location para recorrência Pix AutomáticoA

Cria uma location destinada ao payload de uma recorrência de Pix Automático. Use antes de associar a recorrência e apresentar seu QR Code ao pagador.

Inputs: no named parameters. Returns: Resultado estruturado retornado pela tool pix_create_location_recurrence_automa…

pix_create_recurrence_automaticCriar recorrência de Pix AutomáticoA

Cria uma recorrência que deverá ser autorizada pelo pagador para cobranças Pix Automático futuras. Use no início da jornada de contratação do acordo recorrente.

Inputs: body (required). Returns: Resultado estruturado retornado pela tool pix_create_recurrence_automatic.

pix_create_request_recurrence_automaticCriar solicitação de recorrência Pix AutomáticoA

Cria uma solicitação de confirmação de recorrência de Pix Automático. Use na jornada em que a autorização do pagador depende dessa solicitação antes das cobranças recorrentes.

Inputs: body (required). Returns: Resultado estruturado retornado pela tool pix_create_request_recurrence_automat…

pix_delete_evpRemover chave Pix aleatóriaA
DestructiveIdempotent

Remove uma chave Pix aleatória da conta. Use apenas quando ela não deve mais receber pagamentos; a mesma EVP não poderá ser recriada e cobranças ligadas a ela podem deixar de funcionar.

Inputs: params (required). Returns: Resultado estruturado retornado pela tool pix_delete_evp.

pix_delete_webhookRemover webhook de uma chave PixA
DestructiveIdempotent

Remove a configuração de webhook associada a uma chave Pix. Use quando aquele destino não deve mais receber eventos; a aplicação deixará de receber as notificações correspondentes.

Inputs: params (required). Returns: Resultado estruturado retornado pela tool pix_delete_webhook.

pix_delete_webhook_automatic_chargeRemover webhook de cobranças Pix AutomáticoA
DestructiveIdempotent

Remove a configuração do webhook de cobranças Pix Automático. Use quando o destino não deve mais receber eventos de cobranças e tentativas recorrentes.

Inputs: no named parameters. Returns: Resultado estruturado retornado pela tool pix_delete_webhook_automatic_charge.

pix_delete_webhook_recurrence_automaticRemover webhook de recorrências Pix AutomáticoA
DestructiveIdempotent

Remove a configuração do webhook de recorrências de Pix Automático. Use quando o destino não deve mais receber esses eventos; as notificações correspondentes serão interrompidas.

Inputs: no named parameters. Returns: Resultado estruturado retornado pela tool pix_delete_webhook_recurrence_automat…

pix_detail_automatic_chargeConsultar cobrança Pix AutomáticoA
Read-onlyIdempotent

Consulta pelo txid uma cobrança associada a uma recorrência de Pix Automático. Use para acompanhar agenda, tentativas e estado sem alterar a cobrança.

Inputs: params (required). Returns: Resultado estruturado retornado pela tool pix_detail_automatic_charge.

pix_detail_chargeConsultar cobrança Pix imediataA
Read-onlyIdempotent

Consulta pelo txid os dados, a revisão e o estado de uma cobrança Pix imediata. Use para acompanhar pagamento ou remoção sem modificar a cobrança.

Inputs: params (required). Returns: Resultado estruturado retornado pela tool pix_detail_charge.

pix_detail_devolutionConsultar devolução de PixA
Read-onlyIdempotent

Consulta o estado e os dados de uma devolução já solicitada para um Pix recebido. Use para acompanhar seu processamento sem criar outra devolução ou movimentar valores.

Inputs: params (required). Returns: Resultado estruturado retornado pela tool pix_detail_devolution.

pix_detail_due_chargeConsultar cobrança Pix com vencimentoA
Read-onlyIdempotent

Consulta pelo txid os dados, a revisão e o estado de uma cobrança Pix com vencimento. Use para acompanhar a cobrança ou obter dados para exibição sem alterá-la.

Inputs: params (required). Returns: Resultado estruturado retornado pela tool pix_detail_due_charge.

pix_detail_due_charge_batchConsultar lote de cobranças PixA
Read-onlyIdempotent

Consulta pelo identificador um lote de cobranças Pix com vencimento e seus itens. Use para acompanhar o processamento e as revisões sem modificar o lote.

Inputs: params (required). Returns: Resultado estruturado retornado pela tool pix_detail_due_charge_batch.

pix_detail_locationConsultar location PixA
Read-onlyIdempotent

Consulta uma location Pix pelo identificador e informa sua associação atual. Use para verificar o vínculo com uma cobrança antes de gerar ou reutilizar o QR Code.

Inputs: params (required). Returns: Resultado estruturado retornado pela tool pix_detail_location.

pix_detail_location_recurrence_automaticConsultar location de recorrência Pix AutomáticoA
Read-onlyIdempotent

Consulta uma location de recorrência de Pix Automático e sua associação atual. Use para confirmar o vínculo antes de exibir ou reutilizar o payload.

Inputs: params (required). Returns: Resultado estruturado retornado pela tool pix_detail_location_recurrence_automa…

pix_detail_receivedConsultar Pix recebidoA
Read-onlyIdempotent

Consulta um recebimento Pix pelo identificador end-to-end. Use para confirmar valor, horário, pagador e eventuais devoluções de uma transação já recebida.

Inputs: params (required). Returns: Resultado estruturado retornado pela tool pix_detail_received.

pix_detail_recurrence_automaticConsultar recorrência de Pix AutomáticoA
Read-onlyIdempotent

Consulta uma recorrência de Pix Automático por seu identificador. Use para acompanhar autorização, estado e parâmetros vigentes sem modificar o acordo recorrente.

Inputs: params (required). Returns: Resultado estruturado retornado pela tool pix_detail_recurrence_automatic.

pix_detail_request_recurrence_automaticConsultar solicitação de recorrência Pix AutomáticoA
Read-onlyIdempotent

Consulta uma solicitação de confirmação de recorrência por seu identificador. Use para acompanhar sua resposta e situação sem modificar a recorrência associada.

Inputs: params (required). Returns: Resultado estruturado retornado pela tool pix_detail_request_recurrence_automat…

pix_detail_webhookConsultar webhook de uma chave PixA
Read-onlyIdempotent

Consulta a configuração de webhook associada a uma chave Pix. Use para confirmar URL e criação do vínculo antes de depender das notificações, sem alterar a configuração.

Inputs: params (required). Returns: Resultado estruturado retornado pela tool pix_detail_webhook.

pix_devolutionSolicitar devolução de Pix recebidoA
DestructiveIdempotent

Solicita uma devolução vinculada a um Pix recebido e identifica essa devolução dentro da transação. Use após conferir o recebimento e o valor, pois a operação movimenta saldo.

Inputs: body (required), params (required). Returns: Resultado estruturado retornado pela tool pix_devolution.

pix_generate_qr_codeGerar QR Code de uma location PixA
Read-onlyIdempotent

Gera o Pix Copia e Cola e a imagem do QR Code para uma location existente. Use depois de associar a location à cobrança que o pagador deverá acessar.

Inputs: params (required). Returns: Resultado estruturado retornado pela tool pix_generate_qr_code.

pix_generate_static_qr_codeGerar QR Code Pix estáticoA
Read-onlyIdempotent

Monta localmente um payload Pix estático e sua imagem a partir dos dados do recebedor. Use para apresentar um QR Code sem criar cobrança ou fazer requisição financeira à Efí.

Inputs: body (required). Returns: Resultado estruturado retornado pela tool pix_generate_static_qr_code.

pix_get_receiptObter comprovante de transação PixA
Read-onlyIdempotent

Obtém o comprovante em PDF de uma transação Pix usando um de seus identificadores aceitos. Use para entregar ou arquivar a evidência de uma operação já realizada.

Inputs: params (required). Returns: Resultado estruturado retornado pela tool pix_get_receipt.

pix_keys_bucketConsultar baldes de fichas para chaves PixA
Read-onlyIdempotent

Consulta capacidade, fichas disponíveis e reposição dos baldes usados no gerenciamento de chaves Pix. Use para decidir quando realizar operações de registro de chaves sem consumir uma ficha.

Inputs: no named parameters. Returns: Resultado estruturado retornado pela tool pix_keys_bucket.

pix_list_automatic_chargeListar cobranças Pix AutomáticoA
Read-onlyIdempotent

Lista cobranças associadas a recorrências de Pix Automático conforme os filtros aceitos. Use para acompanhar execuções e conciliar cobranças sem modificá-las.

Inputs: params (required). Returns: Resultado estruturado retornado pela tool pix_list_automatic_charge.

pix_list_chargesListar cobranças Pix imediatasA
Read-onlyIdempotent

Lista cobranças Pix imediatas no período e com os filtros informados. Use em rotinas de acompanhamento e conciliação sem alterar os registros retornados.

Inputs: params (required). Returns: Resultado estruturado retornado pela tool pix_list_charges.

pix_list_due_charge_batchListar lotes de cobranças PixA
Read-onlyIdempotent

Lista lotes de cobranças Pix com vencimento conforme período e filtros aceitos. Use para localizar lotes e acompanhar sua criação sem alterar seus conteúdos.

Inputs: params (required). Returns: Resultado estruturado retornado pela tool pix_list_due_charge_batch.

pix_list_due_chargesListar cobranças Pix com vencimentoA
Read-onlyIdempotent

Lista cobranças Pix com vencimento no período e com os filtros informados. Use em rotinas de acompanhamento e conciliação sem modificar as cobranças encontradas.

Inputs: params (required). Returns: Resultado estruturado retornado pela tool pix_list_due_charges.

pix_list_evpListar chaves Pix aleatóriasA
Read-onlyIdempotent

Lista somente as chaves Pix do tipo aleatória registradas na conta autenticada. Use para inventariar EVPs disponíveis antes de configurar cobranças ou webhooks.

Inputs: no named parameters. Returns: Resultado estruturado retornado pela tool pix_list_evp.

pix_list_location_recurrence_automaticListar locations de recorrência Pix AutomáticoA
Read-onlyIdempotent

Lista locations destinadas a recorrências de Pix Automático. Use para localizar e acompanhar payloads recorrentes sem modificar suas associações.

Inputs: params (required). Returns: Resultado estruturado retornado pela tool pix_list_location_recurrence_automati…

pix_list_recurrence_automaticListar recorrências de Pix AutomáticoA
Read-onlyIdempotent

Lista recorrências de Pix Automático conforme período e filtros informados. Use para acompanhar autorizações e localizar acordos sem alterar seus estados.

Inputs: params (required). Returns: Resultado estruturado retornado pela tool pix_list_recurrence_automatic.

pix_list_webhookListar webhooks PixA
Read-onlyIdempotent

Lista as configurações de webhook Pix conforme os filtros disponíveis. Use para inventariar destinos de notificação e verificar vínculos sem modificá-los.

Inputs: params. Returns: Resultado estruturado retornado pela tool pix_list_webhook.

pix_list_webhook_automatic_chargeConsultar webhook de cobranças Pix AutomáticoA
Read-onlyIdempotent

Consulta a configuração vigente do webhook de cobranças Pix Automático. Use para confirmar o destino dos eventos sem alterar a entrega das notificações.

Inputs: no named parameters. Returns: Resultado estruturado retornado pela tool pix_list_webhook_automatic_charge.

pix_list_webhook_recurrence_automaticConsultar webhook de recorrências Pix AutomáticoA
Read-onlyIdempotent

Consulta a configuração vigente do webhook de recorrências de Pix Automático. Use para confirmar o destino dos eventos sem alterar a entrega das notificações.

Inputs: no named parameters. Returns: Resultado estruturado retornado pela tool pix_list_webhook_recurrence_automatic.

pix_location_listListar locations PixA
Read-onlyIdempotent

Lista locations de payload Pix conforme os filtros informados. Use para localizar associações de cobranças e QR Codes sem modificar seus vínculos.

Inputs: params (required). Returns: Resultado estruturado retornado pela tool pix_location_list.

pix_qr_code_detailDetalhar Pix Copia e ColaA
Read-onlyIdempotent

Decodifica um Pix Copia e Cola, recupera a cobrança dinâmica e verifica a assinatura JWS com o JWKS indicado pelo emissor quando disponível. Use para inspecionar os dados e o estado da verificação; um resultado inválido ou indisponível não autoriza o pagamento.

Inputs: body (required). Returns: Resultado estruturado retornado pela tool pix_qr_code_detail.

pix_qr_code_payPagar QR Code PixA
DestructiveIdempotent

Solicita o pagamento de um QR Code por seu Pix Copia e Cola e um identificador de envio. Use após validar os dados do recebedor e o valor; a operação movimenta saldo da conta.

Inputs: body (required), params (required). Returns: Resultado estruturado retornado pela tool pix_qr_code_pay.

pix_received_listListar Pix recebidosA
Read-onlyIdempotent

Lista recebimentos Pix conforme período e filtros aceitos. Use para conciliar entradas na conta e acompanhar devoluções sem movimentar valores.

Inputs: params (required). Returns: Resultado estruturado retornado pela tool pix_received_list.

pix_resend_webhookReenviar notificações webhook PixA

Solicita o reenvio de notificações Pix dentro do recorte informado. Use para recuperar callbacks não processados; o endpoint configurado poderá receber novamente eventos já emitidos.

Inputs: body (required). Returns: Resultado estruturado retornado pela tool pix_resend_webhook.

pix_retry_request_automaticSolicitar retentativa de cobrança Pix AutomáticoA
Destructive

Solicita uma nova tentativa para uma cobrança de Pix Automático na data identificada. Use quando a cobrança anterior não foi concluída e as condições da recorrência permitirem retentar.

Inputs: params (required). Returns: Resultado estruturado retornado pela tool pix_retry_request_automatic.

pix_sendEnviar PixA
DestructiveIdempotent

Solicita uma transferência Pix para uma chave ou conta favorecida usando um identificador de envio. Use somente após conferir pagador, favorecido e valor; a operação movimenta saldo da conta.

Inputs: body (required), params (required). Returns: Resultado estruturado retornado pela tool pix_send.

pix_send_detailConsultar Pix enviado pelo end-to-end IDA
Read-onlyIdempotent

Consulta um Pix enviado usando seu identificador end-to-end. Use para confirmar processamento, favorecido, valor e devoluções sem iniciar nova transferência.

Inputs: params (required). Returns: Resultado estruturado retornado pela tool pix_send_detail.

pix_send_detail_idConsultar Pix enviado pelo identificador de envioA
Read-onlyIdempotent

Consulta uma transferência Pix pelo identificador atribuído pela aplicação no envio. Use para acompanhar processamento, favorecido e valor sem iniciar outra transferência.

Inputs: params (required). Returns: Resultado estruturado retornado pela tool pix_send_detail_id.

pix_send_listListar Pix enviadosA
Read-onlyIdempotent

Lista transferências Pix enviadas no período e com os filtros informados. Use para acompanhamento e conciliação de saídas sem movimentar valores.

Inputs: params (required). Returns: Resultado estruturado retornado pela tool pix_send_list.

pix_send_same_ownershipEnviar Pix entre contas da mesma titularidadeA
DestructiveIdempotent

Solicita uma transferência Pix exclusivamente para conta da mesma titularidade. Use após conferir origem, destino e valor; a operação movimenta o saldo da conta autenticada.

Inputs: body (required), params (required). Returns: Resultado estruturado retornado pela tool pix_send_same_ownership.

pix_split_configCriar configuração de split PixA

Cria uma configuração de split que define participantes e critérios de distribuição. Use antes de vinculá-la a cobranças Pix que devam repartir valores recebidos.

Inputs: body (required). Returns: Resultado estruturado retornado pela tool pix_split_config.

pix_split_config_idCriar ou substituir configuração de split PixA
DestructiveIdempotent

Cria ou substitui uma configuração de split usando um identificador escolhido. Use quando a aplicação precisar controlar o identificador; vínculos futuros usarão a definição resultante.

Inputs: body (required), params (required). Returns: Resultado estruturado retornado pela tool pix_split_config_id.

pix_split_detail_chargeConsultar split de cobrança Pix imediataA
Read-onlyIdempotent

Consulta a configuração de split vinculada a uma cobrança Pix imediata. Use para verificar como o recebimento será distribuído sem alterar a cobrança ou seus repasses.

Inputs: params (required). Returns: Resultado estruturado retornado pela tool pix_split_detail_charge.

pix_split_detail_configConsultar configuração de split PixA
Read-onlyIdempotent

Consulta participantes e critérios de uma configuração de split Pix. Use para validar a distribuição antes de vinculá-la a uma cobrança ou revisar um vínculo existente.

Inputs: params (required). Returns: Resultado estruturado retornado pela tool pix_split_detail_config.

pix_split_detail_due_chargeConsultar split de cobrança Pix com vencimentoA
Read-onlyIdempotent

Consulta a configuração de split vinculada a uma cobrança Pix com vencimento. Use para verificar a distribuição prevista do recebimento sem alterar seus repasses.

Inputs: params (required). Returns: Resultado estruturado retornado pela tool pix_split_detail_due_charge.

pix_split_devolutionSolicitar devolução de Pix com splitA
DestructiveIdempotent

Solicita a devolução de um Pix recebido que teve distribuição por split. Use após conferir a transação e o valor; a operação movimenta recursos e ajusta os repasses relacionados.

Inputs: body (required), params (required). Returns: Resultado estruturado retornado pela tool pix_split_devolution.

pix_update_automatic_chargeRevisar cobrança Pix AutomáticoA
Destructive

Revisa os campos permitidos de uma cobrança associada a Pix Automático. Use para ajustar a cobrança recorrente enquanto seu estado admitir alteração.

Inputs: body (required), params (required). Returns: Resultado estruturado retornado pela tool pix_update_automatic_charge.

pix_update_chargeRevisar cobrança Pix imediataA
Destructive

Revisa os campos permitidos de uma cobrança Pix imediata identificada pelo txid. Use para atualizar uma cobrança existente enquanto seu estado admitir alteração.

Inputs: body (required), params (required). Returns: Resultado estruturado retornado pela tool pix_update_charge.

pix_update_due_chargeRevisar cobrança Pix com vencimentoA
Destructive

Revisa os campos permitidos de uma cobrança Pix com vencimento identificada pelo txid. Use para atualizar uma cobrança existente enquanto seu estado admitir mudanças.

Inputs: body (required), params (required). Returns: Resultado estruturado retornado pela tool pix_update_due_charge.

pix_update_due_charge_batchRevisar cobranças de um lote PixA
Destructive

Revisa cobranças específicas dentro de um lote Pix com vencimento. Use para alterar somente os itens informados, preservando as demais cobranças do lote.

Inputs: body (required), params (required). Returns: Resultado estruturado retornado pela tool pix_update_due_charge_batch.

pix_update_recurrence_automaticRevisar recorrência de Pix AutomáticoB
Destructive

Revisa os campos permitidos de uma recorrência de Pix Automático. Use quando o acordo existente precisar de ajuste e seu estado ainda admitir a alteração.

Inputs: body (required), params (required). Returns: Resultado estruturado retornado pela tool pix_update_recurrence_automatic.

pix_update_request_recurrence_automaticRevisar solicitação de recorrência Pix AutomáticoA
Destructive

Revisa os campos permitidos de uma solicitação de confirmação de recorrência. Use para ajustar a solicitação enquanto seu estado permitir, antes da autorização final.

Inputs: body (required), params (required). Returns: Resultado estruturado retornado pela tool pix_update_request_recurrence_automat…

refund_cardEstornar pagamento com cartãoA
Destructive

Solicita o estorno total ou parcial de um pagamento realizado com cartão, conforme o contrato do SDK. Use para devolver valores de uma cobrança já paga; a operação movimenta recursos.

Inputs: body (required), params (required). Returns: Resultado estruturado retornado pela tool refund_card.

send_billet_emailReenviar boleto por e-mailA

Reenvia por e-mail o boleto já gerado para uma cobrança. Use quando o pagador precisar receber novamente o documento; a operação não emite uma cobrança diferente.

Inputs: params (required), body. Returns: Resultado estruturado retornado pela tool send_billet_email.

send_carnet_emailReenviar carnê por e-mailA

Reenvia por e-mail um carnê já criado com suas parcelas. Use quando o pagador precisar receber novamente os documentos, sem gerar outro carnê ou novas cobranças.

Inputs: params (required), body. Returns: Resultado estruturado retornado pela tool send_carnet_email.

send_carnet_parcel_emailReenviar parcela de carnê por e-mailA

Reenvia por e-mail uma parcela específica de um carnê existente. Use quando apenas aquele documento precisar ser entregue novamente; as demais parcelas permanecem inalteradas.

Inputs: params (required), body. Returns: Resultado estruturado retornado pela tool send_carnet_parcel_email.

settle_carnetDar baixa manual em um carnêA
DestructiveIdempotent

Marca manualmente um carnê como pago. Use somente quando o recebimento tiver ocorrido por outro meio e precisar ser refletido na Efí, pois a operação altera o estado financeiro do carnê.

Inputs: params (required). Returns: Resultado estruturado retornado pela tool settle_carnet.

settle_carnet_parcelDar baixa manual em uma parcela de carnêA
DestructiveIdempotent

Marca manualmente uma parcela específica de carnê como paga. Use quando o recebimento externo daquela parcela precisar ser registrado, pois a operação altera seu estado financeiro.

Inputs: params (required). Returns: Resultado estruturado retornado pela tool settle_carnet_parcel.

settle_chargeDar baixa manual em uma cobrançaA
DestructiveIdempotent

Marca manualmente uma cobrança como paga. Use somente quando o valor tiver sido recebido por outro meio e o estado precisar ser refletido na Efí, pois há efeito financeiro.

Inputs: params (required). Returns: Resultado estruturado retornado pela tool settle_charge.

update_account_configAtualizar configurações da conta PixA
DestructiveIdempotent

Cria ou modifica regras de recebimento e notificação Pix da conta ou de chaves específicas. Use para controlar formas aceitas de recebimento; a mudança afeta transações futuras.

Inputs: body (required). Returns: Resultado estruturado retornado pela tool update_account_config.

update_billetAtualizar boleto de uma cobrançaB
DestructiveIdempotent

Revisa os dados permitidos de um boleto já associado a uma cobrança. Use para ajustar o boleto enquanto seu estado admitir alteração; a operação modifica a cobrança apresentada ao pagador.

Inputs: body (required), params (required). Returns: Resultado estruturado retornado pela tool update_billet.

update_carnet_metadataAtualizar metadados de um carnêA
DestructiveIdempotent

Atualiza os metadados de integração de um carnê existente. Use para corrigir referências ou informações de notificação sem recriar o carnê nem alterar diretamente o pagamento das parcelas.

Inputs: body (required), params (required). Returns: Resultado estruturado retornado pela tool update_carnet_metadata.

update_carnet_parcelAtualizar uma parcela de carnêA
DestructiveIdempotent

Atualiza os dados permitidos de uma parcela específica de carnê. Use quando somente um vencimento precisar de revisão; a alteração afeta a cobrança apresentada para aquela parcela.

Inputs: body (required), params (required). Returns: Resultado estruturado retornado pela tool update_carnet_parcel.

update_carnet_parcelsAtualizar parcelas de um carnêA
DestructiveIdempotent

Atualiza em conjunto os dados permitidos das parcelas de um carnê. Use para aplicar revisões coordenadas a vários vencimentos; as cobranças das parcelas informadas serão modificadas.

Inputs: body (required), params (required). Returns: Resultado estruturado retornado pela tool update_carnet_parcels.

update_charge_metadataAtualizar metadados de uma cobrançaB
DestructiveIdempotent

Atualiza os metadados de integração de uma cobrança existente, como referência própria e URL de notificação quando aceitas pelo contrato. Use para corrigir o vínculo com o sistema integrador.

Inputs: body (required), params (required). Returns: Resultado estruturado retornado pela tool update_charge_metadata.

update_planAtualizar plano de assinaturaA
DestructiveIdempotent

Atualiza os dados permitidos de um plano de assinatura existente. Use para revisar sua configuração de recorrência; verifique o efeito esperado nas assinaturas vinculadas antes da alteração.

Inputs: body (required), params (required). Returns: Resultado estruturado retornado pela tool update_plan.

update_statement_recurrencyRevisar recorrência de extrato CNAB 240A
Destructive

Atualiza uma recorrência de geração de extrato CNAB 240 já cadastrada. Use para ajustar frequência ou entrega; a mudança afeta as próximas gerações do agendamento.

Inputs: body (required), params (required). Returns: Resultado estruturado retornado pela tool update_statement_recurrency.

update_subscriptionAtualizar uma assinaturaA
DestructiveIdempotent

Atualiza os dados permitidos de uma assinatura existente. Use para revisar a configuração individual do vínculo com o plano sem criar uma nova assinatura.

Inputs: body (required), params (required). Returns: Resultado estruturado retornado pela tool update_subscription.

update_subscription_metadataAtualizar metadados de uma assinaturaA
DestructiveIdempotent

Atualiza os metadados de integração de uma assinatura, como referências usadas pelo sistema chamador. Use para corrigir o vínculo externo sem recriar nem cobrar novamente o assinante.

Inputs: body (required), params (required). Returns: Resultado estruturado retornado pela tool update_subscription_metadata.

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

Loading tool schema changelog…

    TDQS

    A3.5/5.0

    Scored across 173 tools

    Disambiguation2/5

    The tool set is enormous and contains many clusters of near-identical operations, such as the multiple webhook config/list/delete variants and the many create/detail/update Pix charge tools. While descriptions are detailed, an agent is highly likely to confuse tools like pix_create_charge, pix_create_immediate_charge, and pix_create_due_charge, or pick the wrong recurrence/split/webhook variant.

    Naming Consistency4/5

    The vast majority of tools follow a clear snake_case verb_noun pattern, such as create_charge, detail_charge, cancel_charge, and list_charges. Minor inconsistencies exist, including med_defense, pix_qr_code_pay, of_config_update, and plural/singular mismatches like list_statement_recurrences vs create_statement_recurrency, but these are not disruptive.

    Tool Count1/5

    173 tools is an extremely large surface for an MCP server and far exceeds a reasonable tool set for agent navigation. Even though the underlying API is broad, exposing this many endpoints without grouping or selective exposure creates a severe discoverability and selection burden.

    Completeness5/5

    The surface is remarkably complete for the EFI payments domain, covering charges, carnets, subscriptions, plans, Pix immediate/due/automatic/recurrence flows, split, webhooks, reports, Open Finance, account opening, statements, and payment requests. Lifecycle actions such as create, read, update, cancel, settle, and devolution are consistently represented across the major resource types.

    Maintenance

    ActivityInactive
    ResponsivenessNo recent community issues

    Related MCP Connectors

    Related MCP Servers

    • A
      license
      Not graded
      quality
      D
      maintenance
      Enables interaction with Qonto's Business API for banking operations. Supports all API key-accessible endpoints for managing business banking transactions and account information.
      20 PyPI
      3
      MIT
    • A
      license
      Not graded
      quality
      D
      maintenance
      Centralizes payment gateway integrations for Pagar.me (customers, recipients, Pix, credit card, splits, charges) and Woovi/OpenPix (Pix charges, refunds, webhook verification) through MCP tools.
      MIT
    • A
      license
      A
      quality
      D
      maintenance
      Create Pix charges (Woovi/OpenPix) · List payments & check status · Refund transactions · Multi-provider routing · Daily/per-tx spending limits · Human-in-the-loop confirmation · JSONL audit trail
      7
      66 npm
      1
      MIT
    • F
      license
      A
      quality
      D
      maintenance
      Enables interaction with the Conekta payment API to manage orders, customers, subscriptions, and financial transactions. It provides a comprehensive suite of tools for core payment operations like processing refunds, creating checkouts, and monitoring account balances.
      32
      2
      -