mcp-caixa

@codespar/mcp-caixa

MCP server for Caixa Econômica Federal — Brazil's largest state-owned bank.

Caixa occupies a segment none of the private tier-1 banks (Itaú, Bradesco, Santander, BB) can cover: it runs federal social programs (PIS/PASEP, FGTS, Bolsa Família / Auxílio Brasil), operates the national lottery (Loterias Caixa), and is the preferred bank for merchants that value state-bank credibility or serve beneficiaries of federal transfer programs. For the payment surface that matters to merchants — Pix, boleto (Cobrança / SICOB), and extrato — Caixa follows the BACEN Pix v2 standard shared across every tier-1 bank, so the integration shape mirrors its private-sector peers.

Status: alpha (0.1.0-alpha.1)

Caixa's Developer Portal is contract-gated, and as a state-owned institution the onboarding is additionally bureaucratic: vendor registration and credenciamento are required on top of the commercial merchant contract. Full OpenAPI specs for Pix, Cobrança (SICOB), and Extrato are only visible to onboarded merchants. The endpoint paths in this server are best-guesses based on (a) BACEN Pix v2 standard paths, (b) Caixa's public SICOB / Cobrança integration guides, and (c) conventions shared with Itaú / Bradesco / BB. Every unverified path is flagged TODO(verify) in the source.

Pin to exact versions during 0.1.x; paths will be corrected to match the portal spec once an onboarded merchant can validate.

Tools (23)

Tool	Purpose
get_oauth_token	Mint or return a cached OAuth2 client_credentials bearer token for the Caixa Developer Portal.
send_pix	Initiate an outbound Pix payment from the merchant's Caixa account.
create_pix_qr	Create a dynamic Pix charge with QR code (cob).
get_pix	Retrieve a Pix transaction by its BCB endToEndId (E).
resolve_dict_key	Resolve a DICT key (CPF, CNPJ, email, phone, EVP) to the owner's account data before sending a Pix.
refund_pix	Refund (devolução) a previously received Pix.
create_boleto	Issue a boleto via Caixa Cobrança (SICOB).
get_boleto	Retrieve a boleto by its Caixa identifier (id or nosso_numero).
cancel_boleto	Cancel (baixa) an outstanding boleto before payment.
get_statement	Retrieve account statement transactions for a given period.
get_pix_charge	Retrieve a Pix immediate charge (cob) by its BCB txid.
update_pix_charge	Update (PATCH) a Pix immediate charge (cob) — e.g.
list_pix_charges	List Pix immediate charges (cob) filtered by date range and optional status / CPF / CNPJ.
create_pix_due_charge	Create a Pix due-date charge (cobv) with mandatory payer data and due date.
get_pix_due_charge	Retrieve a Pix due-date charge (cobv) by its BCB txid.
list_pix_received	List received Pix transactions (pix recebidos) by date range.
register_dict_key	Register a DICT key (CPF, CNPJ, email, phone, or EVP) to an account owned by the merchant.
delete_dict_key	Delete (unregister) a DICT key owned by the merchant.
download_boleto_pdf	Fetch the rendered boleto PDF for an issued boleto.
get_account_balance	Return the current balance for a Caixa merchant account, including available, blocked, and overdraft limit...
transfer_ted	Initiate an outbound TED transfer from a Caixa merchant account to an external bank account.
consult_fgts	Query FGTS balance / extrato.
pay_tribute	Pay a federal tribute (DARF, GPS, GRU) or other guia de arrecadação via Caixa.

Why Caixa (vs. a private bank)

• Social-program beneficiaries. If a meaningful slice of your customer base receives federal transfers, Caixa is where the money lands first.
• State-bank credibility. Government-adjacent merchants, concessionárias, and regulated verticals often prefer — or are required — to hold accounts at a state-owned bank.
• Lottery / Loterias Caixa corridor. Retailers in the lotérica network settle through Caixa.
• Same Pix / boleto rails as the private banks. No technical tradeoff — the BACEN Pix v2 standard is identical.

Install

npm install @codespar/[email protected]

Environment

CAIXA_CLIENT_ID="..."       # OAuth client_id from Caixa's Developer Portal
CAIXA_CLIENT_SECRET="..."   # OAuth client_secret
CAIXA_CERT_PATH="/abs/path/to/client.crt"   # mTLS client certificate
CAIXA_KEY_PATH="/abs/path/to/client.key"    # mTLS private key
CAIXA_ENV="sandbox"                          # or "production" (default: sandbox)

Authentication

Two factors are both required on every call:

1. OAuth2 client_credentials — the server calls the token endpoint, caches the bearer until ~60s before expiry, and attaches Authorization: Bearer <token> to downstream calls.
2. mTLS — BACEN mandates mutual TLS for Pix v2, and Caixa enforces it across product families. The server loads the client certificate and private key from the paths you set, builds a Node https.Agent, and routes every request through it.

You obtain the cert + key bundle from the Caixa Developer Portal after your merchant contract and credenciamento are approved. They are distinct from the OAuth credentials.

Run

# stdio (default)
npx @codespar/mcp-caixa

# HTTP transport
MCP_HTTP=true MCP_PORT=3000 npx @codespar/mcp-caixa

Caveats

• Paths are unverified. See the TODO(verify) markers in src/index.ts. Onboarded merchants should validate against their portal-issued OpenAPI spec and open a PR.
• Sandbox host is a guess. Caixa issues a homologação subdomain per merchant; override by editing BASE_URL if your provisioned sandbox URL differs.
• SICOB legacy. Older boleto contracts may still route through the legacy SIGCB surface. The create_boleto / get_boleto / cancel_boleto tools target Cobrança v2; if your contract predates it, paths will differ.
• Onboarding timeline. Factor weeks, not days. State-owned vendor registration is the critical path — start it before you start coding.

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