mcp-pix-bcb

@codespar/mcp-pix-bcb

Pix BCB（ブラジル中央銀行の公式 Pix API）向け MCP サーバー

クイックスタート

Claude Desktop

~/.config/claude/claude_desktop_config.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

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

Cursor / VS Code

.cursor/mcp.json または .vscode/mcp.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"
      }
    }
  }
}

ツール（18）

ツール	目的
create_cob	即時 Pix 請求（cobranca imediata）を作成します
get_cob	txid で即時請求の詳細を取得します
list_cobs	日付範囲とフィルターを指定して即時請求を一覧表示します
update_cob	既存の即時請求を更新します（PATCH /cob/{txid}）。
create_cobv	期日付き Pix 請求（cobranca com vencimento）を作成します
list_cobv	日付範囲内の期日付き請求（cobv）を一覧表示します
update_cobv	既存の期日付き請求を更新します（PATCH /cobv/{txid}）
get_pix	e2eid（endToEndId）で受け取った Pix 決済を取得します
list_pix_received	日付範囲内で受け取った Pix 決済を一覧表示します
create_devolucao	受け取った Pix の返金（devolução）をリクエストします（PUT /pix/{e2eid}/devolucao/{id}）
get_devolucao	e2eid と返金 ID で返金の詳細を取得します（GET /pix/{e2eid}/devolucao/{id}）
create_pix_key	DICT に Pix キーを登録します（PSP の対応が必要です）
get_pix_key	DICT で Pix キーを検索します
list_pix_keys	この PSP の認証済みアカウントが所有するすべての Pix キーを一覧表示します
request_key_portability	別の PSP からこの PSP への Pix キーの移行をリクエストします（DICT の移行フロー）
resolve_key_claim	保留中の DICT キー要求を解決します（確認またはキャンセル）— POST /dict/keys/claims/{id}/resolve
set_webhook	指定した Pix キーの Webhook URL を設定します（PUT /webhook/{chave}）。
delete_webhook	Pix キーに設定された Webhook を削除します（DELETE /webhook/{chave}）

認証

Pix BCB API は、mTLS を使用した OAuth2 クライアント認証情報フローを使用します。各 PSP（銀行）がそれぞれのベース URL と証明書要件を提供します。

サンドボックス／テスト

サンドボックスの利用可否は PSP（決済サービスプロバイダー）によって異なります。認証環境へのアクセスについては、ご利用の銀行にお問い合わせください。

認証情報を取得する

1. Pix API ドキュメント（BCB）にアクセスします
2. API アクセスのために、利用する PSP（銀行）に登録します
3. OAuth2 クライアント認証情報と mTLS 証明書を取得します
4. 環境変数を設定します

環境変数

変数	必須	説明
PIX_BASE_URL	はい	PSP API のベース URL（例：https://pix.example.com/api/v2）
PIX_CLIENT_ID	はい	OAuth2 クライアント ID
PIX_CLIENT_SECRET	はい	OAuth2 クライアントシークレット
PIX_CERT_PATH	いいえ	mTLS 証明書（.pem または .p12）へのパス

ロードマップ

v0.2（予定）

• create_location — Pix ロケーション（ペイロード URL）を作成します
• get_location — Pix ロケーションの詳細を取得します
• list_locations — すべての Pix ロケーションを一覧表示します
• create_devolucao — Pix の返金（devolucao）を作成します
• get_devolucao — Pix の返金詳細を取得します

v0.3（予定）

• create_cobv_batch — 期日付き Pix 請求（cobv）のバッチを作成します
• webhook_management — Pix Webhook を登録、取得、削除します

貢献をご希望ですか？PR を作成するか、ツールをリクエストしてください。

リンク

• Pix API 仕様（BCB）
• ブラジル中央銀行
• MCP Dev LATAM
• ランディングページ

エンタープライズ

エージェントによる決済にガバナンス、予算上限、監査証跡が必要ですか？CodeSpar Enterprise は、これらの MCP サーバーにポリシーエンジン、決済ルーティング、コンプライアンステンプレートを追加します。

ライセンス

MIT