Mcp Pix Bcb

io.github.codesparPublished by GitHub account codesparv0.2.2Updated Oct 24, 2026

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

VerifiedSTDIODesktop onlyFinanceBusiness & Commerce

Overview

AI-generated overview

MCP server for the Banco Central do Brasil Pix API, letting an assistant create and manage Pix charges, refunds, keys and webhooks through a PSP.

What you can do
  • Create, read, list and revise immediate Pix charges (cob) and due-date charges (cobv)
  • Look up received Pix payments by end-to-end ID or list them by date range
  • Request and inspect refunds (devolução) for received payments
  • Register, look up and list Pix keys in DICT, request key portability and resolve key claims
  • Configure or remove the webhook URL for a Pix key
When to use it
Useful when you work with a Brazilian PSP that exposes the Pix BCB API and want an assistant to draft, inspect or adjust Pix charges, refunds, keys and webhook settings without leaving the chat.
Requirements
Runs locally via npx (Node.js). Needs a PSP API base URL (PIX_BASE_URL), OAuth2 client ID (PIX_CLIENT_ID) and client secret (PIX_CLIENT_SECRET), plus optionally a path to an mTLS certificate (PIX_CERT_PATH). Credentials and sandbox access must be obtained from your bank.
Before you install
The server holds OAuth2 client credentials and may use an mTLS certificate file, so treat PIX_CLIENT_SECRET and the certificate as sensitive. Several tools create or change real financial records: charges, refunds, Pix key registration and portability, key claim resolution, and webhook configuration or deletion. Point it at a homologation environment first and review any write action before approving it.

Installation

In SourceWeft

  1. Open Mcp Pix Bcb in the dashboard and add it to a workspace.
  2. Enable the server for the chats that should use its tools.

Desktop only via STDIO. STDIO servers start a local process, so they need the SourceWeft desktop host.

Other MCP clients

Follow the launch instructions in the repository.

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

Source: packages/payments/pix-bcb/README.md at commit d0a519a

Tools

0
SourceWeft has not started this package in its sandbox yet, so its tools are not known.

Version history

1
  1. v0.2.2LatestSep 16, 2026

Score

50% of the applicable checks met

How complete this listing is, computed from the registry entry, the endpoint and public sources. Not a rating of the server and not a statement that it is safe or working today: reachability is a dated check, and no installs or reviews go into the score.

  • Reached in the last 30 days25 pts

    Keep the endpoint answering the MCP handshake; SourceWeft probes it every 30 days.

  • Auth declared10 pts

    Declare the credential headers in the registry entry, or keep the endpoint answering the probe so its auth can be classified.

  • Tools listed15 pts

    Answer tools/list without a credential, or ship a package that starts in a sandbox without one.

  • DescriptionRequired15 pts
  • Logo10 pts
  • Documentation15 pts
  • License10 pts