PayZuPayZu Docs

MCP server

MCP é o protocolo aberto que deixa assistentes de IA chamarem ferramentas externas via JSON-RPC. O payzu-mcp-conta-digital expõe 14 tools curadas da API Conta Digital (Pix in/out, TED, transferência interna, saldo, perfil, extrato).

Instalação

Claude Desktop

{
  "mcpServers": {
    "payzu-conta-digital": {
      "command": "npx",
      "args": ["-y", "payzu-mcp-conta-digital"],
      "env": {
        "PAYZU_TOKEN": "<seu-token>"
      }
    }
  }
}

Cursor

.cursor/mcp.json:

{
  "mcpServers": {
    "payzu-conta-digital": {
      "command": "npx",
      "args": ["-y", "payzu-mcp-conta-digital"],
      "env": { "PAYZU_TOKEN": "..." }
    }
  }
}

Configuração

Env varObrigatórioDefaultDescrição
PAYZU_TOKENsim,Bearer token de abrirconta.payzu.com.br
PAYZU_HUB_API_URLnãohttps://pix.payzu.io/v1Base URL da Conta Digital

Lista de tools (14)

Depósitos (4)

ToolHTTP
deposits.create_pixPOST /pix
deposits.get_pixGET /pix/{id}
deposits.proofGET /proof/{id}
deposits.refundPOST /pix/refund/{id}

Saques (6)

ToolHTTP
withdraw.by_pix_keyPOST /withdraw
withdraw.by_bank_dataPOST /withdraw/bank-data
withdraw.tedPOST /ted
withdraw.by_qrPOST /withdraw/qrcode
withdraw.internal_transferPOST /internal-transfer
withdraw.proofGET /proof/{id}

Conta (4)

ToolHTTP
account.balanceGET /user/balance
account.profileGET /user
account.transactionsGET /user/transactions
account.summaryGET /user/summary

Convenções

  • Amounts em REAIS decimais (99.90, não 9990).
  • clientReference obrigatório em criações (idempotência).
  • callbackUrl HTTPS público, responde 2xx em até 5s.
  • Auto-retry em 5xx/429 (3 tentativas, backoff exponencial + jitter).
  • Erros incluem requestId.

Conta Digital vs Pix Processamento

Use payzu-mcp-pix se você quer alto volume de Pix puro com MED, callbacks API, relatórios CSV. Use este pacote pra conta bancária completa (Pix + TED + transferência + extrato).

Suporte

On this page