Skip to main content
Glama
ZuckPay

zuckpay-mcp

Official
by ZuckPay

Server Configuration

Describes the environment variables required to run the server.

NameRequiredDescriptionDefault
ZUCKPAY_BASE_URLNoOverride da base da API (padrão https://www.zuckpay.com.br/conta)https://www.zuckpay.com.br/conta
ZUCKPAY_CLIENT_IDYesClient ID da integração
ZUCKPAY_CLIENT_SECRETYesClient Secret da integração
ZUCKPAY_ENABLE_WITHDRAWNotrue habilita a tool de saque (padrão false)false

Instructions

Guidance the server publishes about itself, which clients place ahead of the tool catalog so the model reads it before choosing anything.

This server publishes no instructions, or was last inspected before Glama recorded them.

Capabilities

Features and capabilities supported by this server

Protocol revision2025-11-25

CapabilityDetails
tools
{
  "listChanged": true
}
prompts
{
  "listChanged": true
}
resources
{
  "listChanged": true
}

Tools

Functions exposed to the LLM to take actions

NameDescription
createPixChargeB

Cria uma cobrança PIX na ZuckPay e retorna o código copia-e-cola, a imagem do QR Code e o link de checkout hospedado. Suporta idempotência (external_id_client), split de receita entre contas, webhook de confirmação (urlnoty) e parâmetros de rastreio (UTMs). Valor em reais com até 2 casas decimais.

getTransactionStatusA

Consulta o status de uma transação ZuckPay (PIX, SPEI ou cartão) pelo transactionId OU pelo external_id_client do seu sistema (exatamente um dos dois). Status possíveis: PENDING, PAID, FAILED, EXPIRADO.

createSpeiCashinA

Cria uma cobrança SPEI em pesos mexicanos (MXN) e retorna a CLABE de 18 dígitos para o pagador transferir de qualquer banco do México. Requer conta ZuckPay com SPEI habilitado. Documento do pagador: RFC ou CURP.

createPayPalOrderA

Cria uma ordem de pagamento no PayPal via ZuckPay e retorna o link de aprovação para o pagador. Suporta 25 moedas (padrão: BRL). Após o pagador aprovar, use capturePayPalOrder para efetivar.

capturePayPalOrderA

Captura (efetiva) uma ordem PayPal já aprovada pelo pagador. Chame somente depois que o pagador abriu o link de aprovação e concluiu o fluxo no PayPal. A captura é idempotente do lado do PayPal.

getCardGatewaysA

Lista os gateways de cartão disponíveis na conta ZuckPay (Stripe internacional e/ou cartão nacional BRL) com suas chaves públicas (publishable keys). Somente leitura — a cobrança direta de cartão não é exposta via MCP por segurança (PCI); use o checkout hospedado da ZuckPay.

listTransactionsA

Lista as transações da conta ZuckPay autenticada (vendas e saques), da mais recente para a mais antiga, com filtros por status, tipo, método de pagamento, ID externo e período (datas no horário de Brasília). Paginada por cursor: traga uma página por vez (padrão 20, máx 50) e use pagination.next_cursor para avançar — NÃO tente carregar tudo de uma vez.

getBalanceA

Consulta os saldos da conta ZuckPay autenticada: disponível para saque, bloqueado (em liberação — PIX libera em D+0; cartão segue o prazo da conta, ex.: D+8) e total, além dos limites e taxa de saque vigentes. Somente leitura, sem parâmetros.

listProductsA

Lista os produtos cadastrados na conta ZuckPay autenticada (nome, preço, status, tipo). Somente leitura — não cria, edita nem exclui produtos.

getProductA

Retorna os detalhes de um produto específico da conta ZuckPay autenticada, pelo ID. Somente leitura.

listCoursesA

Lista os cursos (Meus Cursos / área de membros) dos quais o seller é dono na conta ZuckPay autenticada, com contagem de módulos/aulas/alunos. Somente leitura — não retorna dados de alunos matriculados.

getSalesTodayA

Resumo agregado das vendas do dia (horário de Brasília) da conta ZuckPay autenticada: total pago, contagem, ticket médio, breakdown por método de pagamento e total pendente. Somente leitura, não retorna transações individuais nem dado de comprador.

listInfractionsA

Lista chargebacks e pedidos de reembolso (Infrações e MED) da conta ZuckPay autenticada. Somente leitura. Documento e e-mail do comprador vêm sempre mascarados; nunca retorna o token de reembolso nem campos internos da triagem por IA.

listSubscriptionsA

Lista as assinaturas (recorrências) da conta ZuckPay autenticada: produto, status (ativa/cancelada/inativa/pendente), valor, periodicidade e dados do assinante (mascarados). Somente leitura.

getReferralStatsA

Estatísticas do programa Indique&Ganhe do seller autenticado: total de indicados, comissões (total/pendente/liberada), lista de indicados e histórico de comissões. Somente leitura, escopado estritamente ao próprio seller — nunca retorna ranking ou dado de outros sellers.

getStoreA

Retorna os dados da loja (storefront) da conta ZuckPay autenticada: nome, status, slug, domínio, descrição e redes sociais. Somente leitura — não retorna código customizado nem config de pagamento.

listAcquirerRoutesA

Lista as rotas de adquirente disponíveis para a conta ZuckPay autenticada (PSP, domínio de checkout, taxa de conversão recente), já filtradas por bloqueios/modo configurados na conta. Somente leitura — nunca retorna credenciais de adquirente.

listIntegrationKeysA

Lista os metadados das chaves de integração (API keys) da conta ZuckPay autenticada: nome, domínio, client_id e data de criação. Somente leitura — NUNCA retorna o client_secret. Não existe tool para revelar, criar, rotacionar ou apagar chaves via MCP.

listWebhooksA

Lista os webhooks configurados na conta ZuckPay autenticada (nome, URL, eventos, status). Somente leitura — criação/exclusão de webhook não está disponível via MCP nesta fase.

listPaymentLinksA

Lista os links de pagamento (Link de Pagamentos) cadastrados na conta ZuckPay autenticada: nome, valor, status, slug e visualizações. Somente leitura — não cria nem edita links.

Prompts

Interactive templates invoked by user choice

NameDescription
criar-cobranca-pixGuia a criação de uma cobrança PIX: coleta os dados do pagador que faltarem e chama a tool createPixCharge.

Resources

Contextual data attached and managed by the client

NameDescription
api-docsReferência rápida da API v3: endpoints, campos, idempotência e validação do webhook assinado (HMAC).

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/ZuckPay/zuckpay-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server