PayZuPayZu Docs

MCP server

这是什么

payzu-mcp-pix 是一个本地 MCP 服务器。它通过 npx 在你的机器上运行,并以 stdio 与 AI 助手通信。它不是托管服务器,也没有 URL:助手决定调用哪个 tool,服务器用你的 token 向 Pix Processamento API 发起 HTTP 调用。

MCP 是一个开放协议,让 AI 助手通过 JSON-RPC 调用外部工具。当你希望助手在开发或交互式使用中对账户执行真实操作时,用 MCP。如果目标是让你的生产应用与 PayZu 通信,请用 SDK(payzu-pix)。

需要 payzu-mcp-pix 0.3.0 或更高版本,以及 Node 20 或更高版本。

开始之前

abrirconta.payzu.com.br 获取 API token:

  1. 登录你的账户。
  2. 打开凭证区域(API token 部分)。
  3. 复制 token。该值填入 PAYZU_TOKEN

token 拥有账户的真实访问权限:创建收款、提现和查看余额。请像密码一样对待。建议在每个 agent 操作执行前先批准,而不是让它无人值守地运行。

Google Antigravity

在 Antigravity 界面中:

  1. 在 agent 面板(Agent Manager)顶部点击 ... 菜单。
  2. 选择 MCP Servers,再选 Manage MCP Servers
  3. 点击 View raw config
  4. 粘贴下面的配置,并替换成你的 token:
{
  "mcpServers": {
    "payzu-pix": {
      "command": "npx",
      "args": ["-y", "payzu-mcp-pix"],
      "env": { "PAYZU_TOKEN": "your-token-here" }
    }
  }
}

把 token 原样粘贴进 env。变量展开 ${VAR} 在某些版本会失败。

配置文件位置:

  • 新版本(Antigravity 2.0):~/.gemini/config/mcp_config.json
  • 早期构建:~/.gemini/antigravity/mcp_config.json

保存后在 Manage MCP Servers 界面点击 Refresh

Antigravity 需要 payzu-mcp-pix 0.3.0 或更高版本。旧版本中带点的 tool 名称会被 Antigravity 使用的模型(Gemini、Claude、GPT)拒绝。

Claude Code

claude mcp add payzu-pix --env PAYZU_TOKEN=your-token -- npx -y payzu-mcp-pix

--scope user 让该服务器在所有项目生效:

claude mcp add payzu-pix --scope user --env PAYZU_TOKEN=your-token -- npx -y payzu-mcp-pix

Claude Desktop

编辑 ~/Library/Application Support/Claude/claude_desktop_config.json(macOS)或 %APPDATA%\Claude\claude_desktop_config.json(Windows):

{
  "mcpServers": {
    "payzu-pix": {
      "command": "npx",
      "args": ["-y", "payzu-mcp-pix"],
      "env": { "PAYZU_TOKEN": "your-token-here" }
    }
  }
}

保存后重启 Claude Desktop。

Cursor

编辑项目里的 .cursor/mcp.json,或全局 ~/.cursor/mcp.json:

{
  "mcpServers": {
    "payzu-pix": {
      "command": "npx",
      "args": ["-y", "payzu-mcp-pix"],
      "env": { "PAYZU_TOKEN": "your-token-here" }
    }
  }
}

VS Code (GitHub Copilot)

编辑 .vscode/mcp.json。这里的键是 servers(不是 mcpServers),type 设为 stdio。用 inputs 配合 promptStringpassword,让 token 不被提交:

{
  "servers": {
    "payzu-pix": {
      "type": "stdio",
      "command": "npx",
      "args": ["-y", "payzu-mcp-pix"],
      "env": { "PAYZU_TOKEN": "${input:payzu-token}" }
    }
  },
  "inputs": [
    {
      "id": "payzu-token",
      "type": "promptString",
      "description": "PayZu API token",
      "password": true
    }
  ]
}

Windsurf

编辑 ~/.codeium/windsurf/mcp_config.json,同样的 mcpServers 结构:

{
  "mcpServers": {
    "payzu-pix": {
      "command": "npx",
      "args": ["-y", "payzu-mcp-pix"],
      "env": { "PAYZU_TOKEN": "your-token-here" }
    }
  }
}

使用步骤

  1. abrirconta.payzu.com.br 获取 token。
  2. 用上面某个配置块设置你的客户端(Antigravity、Claude Code、Claude Desktop、Cursor、VS Code 或 Windsurf)。
  3. 用自然语言请求一笔收款,例如:

"创建一笔 R$ 50,00 的 Pix 收款,reference 为 pedido-001,callback 为 https://meusite.com.br/webhook"

  1. agent 调用 pix_create,返回收款的 idqrCodeText
  2. 问"我的余额是多少?",agent 调用 account_balance 并返回数字。

不生效?

  • 错误 [401]:token 无效或已过期。在 abrirconta.payzu.com.br 生成新的。
  • tool 列表里没有该服务器:重新加载或重启客户端(Antigravity 用 Refresh)。

tools 清单(29 个)

所有名称采用 snake_case。每个 tool 的 description 包含直达文档对应 endpoint 页面的链接。

Pix 收款(4)

ToolHTTP
pix_createPOST /pix
pix_getGET /pix
pix_qr_codeGET /pix/qr-code/{transactionId}
pix_proofGET /proof/{id}

提现(6)

ToolHTTP
withdraw_createPOST /withdraw
withdraw_getGET /withdraw
withdraw_by_qrPOST /withdraw/qrcode
withdraw_read_qrPOST /pix/qrcode/read
withdraw_dictGET /pix/key?pixKey={key}
withdraw_proofGET /withdraw/proof/{id}

内部转账(2)

ToolHTTP
internal_transfer_createPOST /internal-transfer
internal_transfer_getGET /internal-transfer

账户(2)

ToolHTTP
account_profileGET /user
account_balanceGET /user/balance

报表(6)

ToolHTTP
reports_list_transactionsGET /user/transactions
reports_get_transactionGET /user/transactions/{id}
reports_create_csvPOST /user/report
reports_list_jobsGET /user/report
reports_get_jobGET /user/report/{id}
reports_downloadPOST /user/report/{id}/download

callbacks(4)

ToolHTTP
callbacks_listGET /user/callbacks
callbacks_getGET /user/callbacks/{id}
callbacks_resendPOST /user/callbacks/resend/{transactionId}
callbacks_resend_bulkPOST /user/callbacks/resend

MED 违规(5)

ToolHTTP
infractions_listGET /user/infractions
infractions_getGET /user/infractions/{id}
infractions_create_defensePOST /user/infractions/{id}/defenses(multipart)
infractions_list_defensesGET /user/infractions/{id}/defenses
infractions_get_defenseGET /user/infractions/{id}/defenses/{defenseId}

默认约定

  • 金额以雷亚尔小数形式传入。tool 拒绝分单位:9990 会触发校验错误,必须是 99.90
  • 创建类调用必须传 clientReference(幂等)。
  • 创建类调用必须传 callbackUrl,否则没人通知你状态。
  • 5xx/429 自动重试,采用指数退避 + jitter(最多 3 次)。
  • 错误信息包含 requestId,如需协助直接复制给支持团队。
  • 零 admin endpoints,仅暴露公开与客户端层面。

环境变量

Env var必填默认值说明
PAYZU_TOKEN来自 abrirconta.payzu.com.br 的 token
PAYZU_API_URLhttps://api.payzu.processamento.com/v1whitelabel 场景下覆盖

支持

On this page