{"_id":"@codespar/mcp-pix-bcb","_rev":"6-a0278aaa5746c3b7b34f82a01e7fb7e4","name":"@codespar/mcp-pix-bcb","dist-tags":{"latest":"0.2.2"},"versions":{"0.1.0":{"name":"@codespar/mcp-pix-bcb","version":"0.1.0","keywords":["mcp","pix","bcb","banco-central","payments","brazil"],"license":"MIT","_id":"@codespar/mcp-pix-bcb@0.1.0","maintainers":[{"name":"codespar-npm","email":"contact@codespar.dev"}],"bin":{"mcp-pix-bcb":"dist/index.js"},"dist":{"shasum":"3393a67d16d9f13c4fc97b66ffdc033971872c62","tarball":"https://registry.npmjs.org/@codespar/mcp-pix-bcb/-/mcp-pix-bcb-0.1.0.tgz","fileCount":4,"integrity":"sha512-PAiCbHVkkkaHGo9+/MEdcmNL+him7RZN6YLKdZg1VZKl8TyWWRxX4MfEG/xLDkbK4FcTt8huQfdtl6CkbI6jWw==","signatures":[{"sig":"MEUCIQDQUe4XzM6Et+mO04Kkg9Iw3OKrYc5J1CwstptlR2T9cgIgTUT1AonhEPcRDuGEZ322VSVZU1xD8iIb5sz5NjKeWyw=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":30500},"main":"./dist/index.js","type":"module","types":"./dist/index.d.ts","gitHead":"ac49d04d5aa50ad5dc16233f0bba88213f917641","scripts":{"build":"tsc","start":"node dist/index.js"},"_npmUser":{"name":"codespar-npm","email":"contact@codespar.dev"},"_npmVersion":"11.8.0","description":"MCP server for Pix BCB API — official Banco Central do Brasil Pix standard","directories":{},"_nodeVersion":"25.5.0","dependencies":{"@modelcontextprotocol/sdk":"^1.0.0"},"_hasShrinkwrap":false,"devDependencies":{"typescript":"^5.8.0","@types/node":"^25.5.0"},"_npmOperationalInternal":{"tmp":"tmp/mcp-pix-bcb_0.1.0_1774923308336_0.5193000623145279","host":"s3://npm-registry-packages-npm-production"}},"0.1.2":{"name":"@codespar/mcp-pix-bcb","version":"0.1.2","keywords":["mcp","pix","bcb","banco-central","payments","brazil"],"license":"MIT","_id":"@codespar/mcp-pix-bcb@0.1.2","maintainers":[{"name":"codespar-npm","email":"contact@codespar.dev"}],"bin":{"mcp-pix-bcb":"dist/index.js"},"dist":{"shasum":"1cc564bb389122d62f26c9ec3daaefd94b5fefc6","tarball":"https://registry.npmjs.org/@codespar/mcp-pix-bcb/-/mcp-pix-bcb-0.1.2.tgz","fileCount":7,"integrity":"sha512-szZZ1xt53pUZ28d47PuFg7yw7uIOBsHAWpSmoGyxfEWGTnceTZdcQv/2YJ9LfudIgHSq75Un1kvOCflqZvBNVA==","signatures":[{"sig":"MEUCIQDd0johWL5h5KTgfQC89k7z4Oy057IbkDLdQCVq591pHAIgEWU/bHn1z/kf6t4Oc3APHYA61eDetmrEeEcrh31cuG8=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":41416},"main":"./dist/index.js","type":"module","types":"./dist/index.d.ts","gitHead":"8fd47fad095cdf96618460a39345eddfe2a4af21","mcpName":"io.github.codespar/mcp-pix-bcb","scripts":{"build":"tsc","start":"node dist/index.js"},"_npmUser":{"name":"codespar-npm","email":"contact@codespar.dev"},"_npmVersion":"11.8.0","description":"MCP server for Pix BCB API — official Banco Central do Brasil Pix standard","directories":{},"_nodeVersion":"25.5.0","dependencies":{"@modelcontextprotocol/sdk":"^1.0.0"},"_hasShrinkwrap":false,"devDependencies":{"typescript":"^5.8.0","@types/node":"^25.5.0"},"_npmOperationalInternal":{"tmp":"tmp/mcp-pix-bcb_0.1.2_1775953792073_0.8807674170657205","host":"s3://npm-registry-packages-npm-production"}},"0.2.0":{"name":"@codespar/mcp-pix-bcb","version":"0.2.0","keywords":["mcp","pix","bcb","banco-central","payments","brazil"],"license":"MIT","_id":"@codespar/mcp-pix-bcb@0.2.0","maintainers":[{"name":"codespar-npm","email":"contact@codespar.dev"}],"bin":{"mcp-pix-bcb":"dist/index.js"},"dist":{"shasum":"944a179cb1ffff2c11af96b96b5a30dda9fc2572","tarball":"https://registry.npmjs.org/@codespar/mcp-pix-bcb/-/mcp-pix-bcb-0.2.0.tgz","fileCount":7,"integrity":"sha512-3uyp/CmprHPUXDvZsxspKR1zQ49mXfHp3bxABBqhWDvwZ5bVgfSXod3EbJDwmZ7dXN4UiD0GDry9QOqxhEIFaA==","signatures":[{"sig":"MEQCIBxrCRcDcZwtqEKWimpUSXx1KZ5hulByjcIeqygQOHHeAiAHv0f8MO6hSHKk+jJ7drRJ26TyxTTtVUbA48SfD5ZmiA==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":62287},"main":"./dist/index.js","type":"module","types":"./dist/index.d.ts","gitHead":"4d61b23e069b421d30d91b4b27c118ae36267449","mcpName":"io.github.codespar/mcp-pix-bcb","scripts":{"build":"tsc","start":"node dist/index.js"},"_npmUser":{"name":"codespar-npm","email":"contact@codespar.dev"},"_npmVersion":"11.8.0","description":"MCP server for Pix BCB API — official Banco Central do Brasil Pix standard","directories":{},"_nodeVersion":"25.5.0","dependencies":{"@modelcontextprotocol/sdk":"^1.0.0"},"_hasShrinkwrap":false,"devDependencies":{"typescript":"^5.8.0","@types/node":"^25.5.0"},"_npmOperationalInternal":{"tmp":"tmp/mcp-pix-bcb_0.2.0_1777115028259_0.5964310777377595","host":"s3://npm-registry-packages-npm-production"}},"0.2.1":{"name":"@codespar/mcp-pix-bcb","version":"0.2.1","keywords":["mcp","pix","bcb","banco-central","payments","brazil"],"license":"MIT","_id":"@codespar/mcp-pix-bcb@0.2.1","maintainers":[{"name":"codespar-npm","email":"contact@codespar.dev"}],"bin":{"mcp-pix-bcb":"dist/index.js"},"dist":{"shasum":"fd7f24729d68894fd1e198e9aa76fa2f1b34510d","tarball":"https://registry.npmjs.org/@codespar/mcp-pix-bcb/-/mcp-pix-bcb-0.2.1.tgz","fileCount":7,"integrity":"sha512-2n+lfdcJYSXjlwzCx7vieR6dFK11R6hBEvxGKUXu4Gq+OEmAOGp9SFYuMW35d7/ok86d4qZPNdjl1aGAhg8ArQ==","signatures":[{"sig":"MEUCIB2fnHbtz9siytbbK4HqfTu7S8A8eLoaIrez3FW+5yWkAiEA6OpnkGzDdv08PVyNMOSvZJzkRr5nWWhDljOY3Ui1gM8=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":63209},"main":"./dist/index.js","type":"module","types":"./dist/index.d.ts","gitHead":"0ab801a863239f0cb986bbda65abbaee3c621b44","mcpName":"io.github.codespar/mcp-pix-bcb","scripts":{"build":"tsc","start":"node dist/index.js"},"_npmUser":{"name":"codespar-npm","email":"contact@codespar.dev"},"_npmVersion":"11.8.0","description":"MCP server for Pix BCB API — official Banco Central do Brasil Pix standard","directories":{},"_nodeVersion":"25.5.0","dependencies":{"@modelcontextprotocol/sdk":"^1.0.0"},"_hasShrinkwrap":false,"devDependencies":{"typescript":"^5.8.0","@types/node":"^25.5.0"},"_npmOperationalInternal":{"tmp":"tmp/mcp-pix-bcb_0.2.1_1777123249401_0.9778171192822531","host":"s3://npm-registry-packages-npm-production"}},"0.2.2":{"name":"@codespar/mcp-pix-bcb","version":"0.2.2","description":"MCP server for Pix BCB API — official Banco Central do Brasil Pix standard","type":"module","main":"./dist/index.js","bin":{"mcp-pix-bcb":"dist/index.js"},"scripts":{"build":"tsc","start":"node dist/index.js"},"dependencies":{"@modelcontextprotocol/sdk":"^1.0.0"},"devDependencies":{"@types/node":"^25.5.0","typescript":"^5.8.0"},"license":"MIT","keywords":["mcp","pix","bcb","banco-central","payments","brazil"],"mcpName":"io.github.codespar/mcp-pix-bcb","_id":"@codespar/mcp-pix-bcb@0.2.2","gitHead":"e8f2ad023876683538fe7b66a2fc88ab8d8ef92f","types":"./dist/index.d.ts","_nodeVersion":"22.22.3","_npmVersion":"10.9.8","dist":{"integrity":"sha512-sSaGPW3sszz/r++Mbr20Wjjr7XRDCrbaEpgQsbzas6BnLpaOz9NdIhaO0O6nEnRdKIb5hYdh8+ionfP3UyYOVA==","shasum":"30f66a48093dc833cdd7f8b453772ef7bcda466b","tarball":"https://registry.npmjs.org/@codespar/mcp-pix-bcb/-/mcp-pix-bcb-0.2.2.tgz","fileCount":7,"unpackedSize":64494,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCIDKnzLmCaJk7tNP7v0ZnVOMA7WQAKnct025rHu2EP15gAiBrGiGJA7yOHszbJ2BmVHfWyIgcPlBum/a7wj3+FrtkSQ=="}]},"_npmUser":{"name":"codespar-npm","email":"fabiano@codespar.dev"},"directories":{},"maintainers":[{"name":"codespar-npm","email":"fabiano@codespar.dev"},{"name":"dangazineu","email":"daniel.gazineu@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/mcp-pix-bcb_0.2.2_1782153943957_0.14896046866507118"},"_hasShrinkwrap":false}},"time":{"created":"2026-03-31T02:15:08.255Z","modified":"2026-06-22T18:45:44.271Z","0.1.0":"2026-03-31T02:15:08.492Z","0.1.2":"2026-04-12T00:29:52.201Z","0.2.0":"2026-04-25T11:03:48.419Z","0.2.1":"2026-04-25T13:20:49.593Z","0.2.2":"2026-06-22T18:45:44.131Z"},"license":"MIT","keywords":["mcp","pix","bcb","banco-central","payments","brazil"],"description":"MCP server for Pix BCB API — official Banco Central do Brasil Pix standard","maintainers":[{"name":"codespar-npm","email":"fabiano@codespar.dev"},{"name":"dangazineu","email":"daniel.gazineu@gmail.com"}],"readme":"# @codespar/mcp-pix-bcb\n\n> MCP server for **Pix BCB** — official Banco Central do Brasil Pix API\n\n[![npm](https://img.shields.io/npm/v/@codespar/mcp-pix-bcb)](https://www.npmjs.com/package/@codespar/mcp-pix-bcb)\n[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)\n\n## Quick Start\n\n### Claude Desktop\n\nAdd to `~/.config/claude/claude_desktop_config.json`:\n\n```json\n{\n  \"mcpServers\": {\n    \"pix-bcb\": {\n      \"command\": \"npx\",\n      \"args\": [\"-y\", \"@codespar/mcp-pix-bcb\"],\n      \"env\": {\n        \"PIX_BASE_URL\": \"https://pix.example.com/api/v2\",\n        \"PIX_CLIENT_ID\": \"your-client-id\",\n        \"PIX_CLIENT_SECRET\": \"your-client-secret\",\n        \"PIX_CERT_PATH\": \"/path/to/certificate.pem\"\n      }\n    }\n  }\n}\n```\n\n### Claude Code\n\n```bash\nclaude mcp add pix-bcb -- npx @codespar/mcp-pix-bcb\n```\n\n### Cursor / VS Code\n\nAdd to `.cursor/mcp.json` or `.vscode/mcp.json`:\n\n```json\n{\n  \"servers\": {\n    \"pix-bcb\": {\n      \"command\": \"npx\",\n      \"args\": [\"-y\", \"@codespar/mcp-pix-bcb\"],\n      \"env\": {\n        \"PIX_BASE_URL\": \"https://pix.example.com/api/v2\",\n        \"PIX_CLIENT_ID\": \"your-client-id\",\n        \"PIX_CLIENT_SECRET\": \"your-client-secret\",\n        \"PIX_CERT_PATH\": \"/path/to/certificate.pem\"\n      }\n    }\n  }\n}\n```\n\n## Tools (18)\n\n| Tool | Purpose |\n|---|---|\n| `create_cob` | Create an immediate Pix charge (cobranca imediata) |\n| `get_cob` | Get immediate charge details by txid |\n| `list_cobs` | List immediate charges with date range and filters |\n| `update_cob` | Revise an existing immediate charge (PATCH /cob/{txid}). |\n| `create_cobv` | Create a due-date Pix charge (cobranca com vencimento) |\n| `list_cobv` | List due-date charges (cobv) within a date range |\n| `update_cobv` | Revise an existing due-date charge (PATCH /cobv/{txid}) |\n| `get_pix` | Get a received Pix payment by e2eid (endToEndId) |\n| `list_pix_received` | List received Pix payments within a date range |\n| `create_devolucao` | Request a refund (devolução) for a received Pix (PUT /pix/{e2eid}/devolucao/{id}) |\n| `get_devolucao` | Get refund details by e2eid + refund id (GET /pix/{e2eid}/devolucao/{id}) |\n| `create_pix_key` | Register a Pix key in DICT (requires PSP support) |\n| `get_pix_key` | Look up a Pix key in DICT |\n| `list_pix_keys` | List all Pix keys owned by the authenticated account at this PSP |\n| `request_key_portability` | Request portability of a Pix key from another PSP into this PSP (DICT portability flow) |\n| `resolve_key_claim` | Resolve a pending DICT key claim (confirm or cancel) — POST /dict/keys/claims/{id}/resolve |\n| `set_webhook` | Configure a webhook URL for a given Pix key (PUT /webhook/{chave}). |\n| `delete_webhook` | Remove the webhook configured for a Pix key (DELETE /webhook/{chave}) |\n\n## Authentication\n\nThe Pix BCB API uses OAuth2 client credentials with mTLS. Each PSP (bank) provides their own base URL and certificate requirements.\n\n## Sandbox / Testing\n\nSandbox availability varies by PSP (payment service provider). Contact your bank for homologation environment access.\n\n### Get your credentials\n\n1. Go to [Pix API Documentation (BCB)](https://bacen.github.io/pix-api/)\n2. Register with your PSP (bank) for API access\n3. Obtain your OAuth2 client credentials and mTLS certificate\n4. Set the environment variables\n\n## Environment Variables\n\n| Variable | Required | Description |\n|----------|----------|-------------|\n| `PIX_BASE_URL` | Yes | PSP API base URL (e.g., `https://pix.example.com/api/v2`) |\n| `PIX_CLIENT_ID` | Yes | OAuth2 client ID |\n| `PIX_CLIENT_SECRET` | Yes | OAuth2 client secret |\n| `PIX_CERT_PATH` | No | Path to mTLS certificate (.pem or .p12) |\n\n## Roadmap\n\n### v0.2 (planned)\n- `create_location` — Create a Pix location (payload URL)\n- `get_location` — Get details of a Pix location\n- `list_locations` — List all Pix locations\n- `create_devolucao` — Create a Pix refund (devolucao)\n- `get_devolucao` — Get Pix refund details\n\n### v0.3 (planned)\n- `create_cobv_batch` — Create a batch of due-date Pix charges (cobv)\n- `webhook_management` — Register, get, and delete Pix webhooks\n\nWant to contribute? [Open a PR](https://github.com/codespar/mcp-dev-latam) or [request a tool](https://github.com/codespar/mcp-dev-latam/issues).\n\n## Links\n\n- [Pix API Specification (BCB)](https://bacen.github.io/pix-api/)\n- [Banco Central do Brasil](https://www.bcb.gov.br)\n- [MCP Dev LATAM](https://github.com/codespar/mcp-dev-latam)\n- [Landing Page](https://codespar.dev/mcp)\n\n## Enterprise\n\nNeed governance, budget limits, and audit trails for agent payments? [CodeSpar Enterprise](https://codespar.dev/enterprise) adds policy engine, payment routing, and compliance templates on top of these MCP servers.\n\n## License\n\nMIT\n","readmeFilename":"README.md"}