Skip to main content
CA

Caixa

v0.2.0-alpha.2OAuth2alpha

BR state-owned public bank. Distinct from private peers: Caixa handles social programs (FGTS, PIS/PASEP, bolsa família), lotteries, and merchants needing state-bank credibility. OAuth2 + mTLS (BACEN Pix v2). Alpha on npm — state-owned onboarding + contract-gated docs.

23 tools5 env vars🇧🇷 Brazilalpha — pending validation

What your agent can do

Caixa gives your agent 23 tools it calls directly — pick the ones it needs, in Claude, Cursor, or any MCP client.

  • get_oauth_tokenMint or return a cached OAuth2 client_credentials bearer token for the Caixa Developer Portal. Exposed so agents can inspect token freshness; normal tool calls obtain tokens implicitly.
  • send_pixInitiate an outbound Pix payment from the merchant's Caixa account. Amount in BRL major units (e.g. '10.50').
  • create_pix_qrCreate a dynamic Pix charge with QR code (cob). Returns the txid, copy-paste EMV payload, and location URL.
Example call
// Your agent calls a tool directly — no glue code.
// CodeSpar's managed tier handles OAuth2, token rotation and rate limits.
const result = await session.call("get_oauth_token", { /* ... */ });

Install

terminal
$ npm install @codespar/mcp-caixa@alpha

Quickstart

Add this entry to your claude_desktop_config.json (or any MCP-compatible client config).

claude_desktop_config.json
{
  "mcpServers": {
    "caixa": {
      "command": "npx",
      "args": [
        "-y",
        "@codespar/mcp-caixa@alpha"
      ],
      "env": {
        "CAIXA_CLIENT_ID": "<your_caixa_client_id>",
        "CAIXA_CLIENT_SECRET": "<your_caixa_client_secret>",
        "CAIXA_CERT_PATH": "<your_caixa_cert_path>",
        "CAIXA_KEY_PATH": "<your_caixa_key_path>"
      }
    }
  }
}

After restart, your agent can call any of the 23 tools below — try get_oauth_token first.

Environment variables · 5

Required to authenticate the server. Stored encrypted when using CodeSpar managed hosting.

CAIXA_CLIENT_ID
required

Caixa OAuth client_id issued via the Developer Portal after contract onboarding.

CAIXA_CLIENT_SECRET
requiredsecret

Caixa OAuth client_secret.

CAIXA_CERT_PATH
required

Absolute path to the mTLS client certificate (.crt or .pem). BACEN mandates mTLS for Pix v2.

CAIXA_KEY_PATH
requiredsecret

Absolute path to the mTLS private key (.key or .pem).

CAIXA_ENV
optional

Environment: 'sandbox' or 'production'. Defaults to 'sandbox'.

Available tools · 23

Each tool is independent — your agent loads only what it needs to reduce context and response time.

READget_oauth_token
Mint or return a cached OAuth2 client_credentials bearer token for the Caixa Developer Portal. Exposed so agents can inspect token freshness; normal tool calls obtain tokens implicitly.
WRITEsend_pix
Initiate an outbound Pix payment from the merchant's Caixa account. Amount in BRL major units (e.g. '10.50').
WRITEcreate_pix_qr
Create a dynamic Pix charge with QR code (cob). Returns the txid, copy-paste EMV payload, and location URL.
READget_pix
Retrieve a Pix transaction by its BCB endToEndId (E<ispb><yyyymmddhhmm><sequence>).
READresolve_dict_key
Resolve a DICT key (CPF, CNPJ, email, phone, EVP) to the owner's account data before sending a Pix. Subject to BCB rate limits per consenting payer.
DELETErefund_pix
Refund (devolução) a previously received Pix. Must reference the original endToEndId and a merchant-side refund id.
WRITEcreate_boleto
Issue a boleto via Caixa Cobrança (SICOB). Returns nosso_numero, linha_digitável, barcode, and PDF URL.
READget_boleto
Retrieve a boleto by its Caixa identifier (id or nosso_numero).

Compatible frameworks

MCP is a protocol — any framework that speaks it can mount this server.

Claude Agent SDKAnthropic
OpenAI AgentsOpenAI
Vercel AI SDKVercel
LangChainLangChain
LlamaIndexLlamaIndex
CrewAICrewAI
MastraMastra
Any MCP clientProtocol

Frequently asked questions

Run `npx -y @codespar/mcp-caixa` and add the config block above to your MCP client — Claude, Cursor, VS Code, or any MCP-compatible client. No build step, no SDK required. Prefer hosted? CodeSpar's managed tier runs it for you with auth handled.
Caixa — MCP server · 23 tools | CodeSpar