Mcp Pix Bcb

io.github.codespar由 GitHub 账号 codespar 发布v0.2.2更新于 Oct 24, 2026

MCP server for Pix BCB API — official Banco Central do Brasil Pix standard

已验证STDIO仅桌面金融商业与电商

概览

AI 生成的概览

面向巴西央行 Pix API 的 MCP 服务器,让助手通过 PSP 创建和管理 Pix 收款、退款、密钥与 webhook。

可以做什么
  • 创建、查询、列出和修改即时 Pix 收款(cob)与到期日收款(cobv)
  • 按 end-to-end ID 查询已收到的 Pix 付款,或按日期范围列出
  • 为已收付款发起退款(devolução)并查询退款详情
  • 在 DICT 中注册、查询和列出 Pix 密钥,申请密钥可移植性并处理密钥认领
  • 为某个 Pix 密钥配置或删除 webhook 地址
适用场景
当你使用提供 Pix BCB API 的巴西 PSP,并希望助手在对话中起草、查看或调整 Pix 收款、退款、密钥和 webhook 设置时适用。
运行要求
通过 npx 在本地运行(需要 Node.js)。需要 PSP 的 API 基础地址(PIX_BASE_URL)、OAuth2 客户端 ID(PIX_CLIENT_ID)和客户端密钥(PIX_CLIENT_SECRET),可选提供 mTLS 证书路径(PIX_CERT_PATH)。凭据与沙箱环境需向你的银行申请。
安装前请注意
服务器持有 OAuth2 客户端凭据,并可能使用 mTLS 证书文件,请将 PIX_CLIENT_SECRET 和证书视为敏感信息。多个工具会创建或修改真实金融记录:收款、退款、Pix 密钥注册与可移植性、密钥认领处理,以及 webhook 的配置或删除。建议先在测试环境使用,并在批准任何写入操作前仔细核对。

安装

在 SourceWeft 中

  1. 打开 控制台中的 Mcp Pix Bcb,将其添加到工作区。
  2. 为需要使用其工具的对话启用该服务。

Desktop only,通过 STDIO。 STDIO 服务会启动本地进程,因此需要 SourceWeft 桌面宿主。

其他 MCP 客户端

参照 仓库 中的启动说明。

README

@codespar/mcp-pix-bcb

MCP server for Pix BCB — official Banco Central do Brasil Pix API

[npm] [License: MIT]

Quick Start

Claude Desktop

Add to ~/.config/claude/claude_desktop_config.json:

json
{  "mcpServers": {    "pix-bcb": {      "command": "npx",      "args": ["-y", "@codespar/mcp-pix-bcb"],      "env": {        "PIX_BASE_URL": "https://pix.example.com/api/v2",        "PIX_CLIENT_ID": "your-client-id",        "PIX_CLIENT_SECRET": "your-client-secret",        "PIX_CERT_PATH": "/path/to/certificate.pem"      }    }  }}

Claude Code

bash
claude mcp add pix-bcb -- npx @codespar/mcp-pix-bcb

Cursor / VS Code

Add to .cursor/mcp.json or .vscode/mcp.json:

json
{  "servers": {    "pix-bcb": {      "command": "npx",      "args": ["-y", "@codespar/mcp-pix-bcb"],      "env": {        "PIX_BASE_URL": "https://pix.example.com/api/v2",        "PIX_CLIENT_ID": "your-client-id",        "PIX_CLIENT_SECRET": "your-client-secret",        "PIX_CERT_PATH": "/path/to/certificate.pem"      }    }  }}

Tools (18)

ToolPurpose
create_cobCreate an immediate Pix charge (cobranca imediata)
get_cobGet immediate charge details by txid
list_cobsList immediate charges with date range and filters
update_cobRevise an existing immediate charge (PATCH /cob/{txid}).
create_cobvCreate a due-date Pix charge (cobranca com vencimento)
list_cobvList due-date charges (cobv) within a date range
update_cobvRevise an existing due-date charge (PATCH /cobv/{txid})
get_pixGet a received Pix payment by e2eid (endToEndId)
list_pix_receivedList received Pix payments within a date range
create_devolucaoRequest a refund (devolução) for a received Pix (PUT /pix/{e2eid}/devolucao/{id})
get_devolucaoGet refund details by e2eid + refund id (GET /pix/{e2eid}/devolucao/{id})
create_pix_keyRegister a Pix key in DICT (requires PSP support)
get_pix_keyLook up a Pix key in DICT
list_pix_keysList all Pix keys owned by the authenticated account at this PSP
request_key_portabilityRequest portability of a Pix key from another PSP into this PSP (DICT portability flow)
resolve_key_claimResolve a pending DICT key claim (confirm or cancel) — POST /dict/keys/claims/{id}/resolve
set_webhookConfigure a webhook URL for a given Pix key (PUT /webhook/{chave}).
delete_webhookRemove the webhook configured for a Pix key (DELETE /webhook/{chave})

Authentication

The Pix BCB API uses OAuth2 client credentials with mTLS. Each PSP (bank) provides their own base URL and certificate requirements.

Sandbox / Testing

Sandbox availability varies by PSP (payment service provider). Contact your bank for homologation environment access.

Get your credentials

  1. Go to Pix API Documentation (BCB)
  2. Register with your PSP (bank) for API access
  3. Obtain your OAuth2 client credentials and mTLS certificate
  4. Set the environment variables

Environment Variables

VariableRequiredDescription
PIX_BASE_URLYesPSP API base URL (e.g., https://pix.example.com/api/v2)
PIX_CLIENT_IDYesOAuth2 client ID
PIX_CLIENT_SECRETYesOAuth2 client secret
PIX_CERT_PATHNoPath to mTLS certificate (.pem or .p12)

Roadmap

v0.2 (planned)

  • create_location — Create a Pix location (payload URL)
  • get_location — Get details of a Pix location
  • list_locations — List all Pix locations
  • create_devolucao — Create a Pix refund (devolucao)
  • get_devolucao — Get Pix refund details

v0.3 (planned)

  • create_cobv_batch — Create a batch of due-date Pix charges (cobv)
  • webhook_management — Register, get, and delete Pix webhooks

Want to contribute? Open a PR or request a tool.

Links

Enterprise

Need governance, budget limits, and audit trails for agent payments? CodeSpar Enterprise adds policy engine, payment routing, and compliance templates on top of these MCP servers.

License

MIT

来源:packages/payments/pix-bcb/README.md,提交 d0a519a

工具

0
SourceWeft 尚未在沙箱中启动过该软件包,因此其工具未知。

版本历史

1
  1. v0.2.2最新Sep 16, 2026

评分

已满足适用检查项的 50%

该评分衡量此收录条目的完整程度,依据注册中心条目、端点与公开来源计算得出。它不是对服务器本身的评价,也不表示服务器安全或当前可用:可连通性是带日期的检查结果,评分也不包含安装量或用户评价。

  • 近 30 天内可连通25 分

    请保持端点能够响应 MCP 握手;SourceWeft 每 30 天探测一次。

  • 已声明认证方式10 分

    请在注册中心条目中声明凭据请求头,或保持端点能够响应探测,以便判定其认证方式。

  • 已列出工具15 分

    请让服务器在无凭据时响应 tools/list,或发布可在沙箱中无凭据启动的软件包。

  • 描述必需15 分
  • 图标10 分
  • 文档15 分
  • 许可证10 分