payzu-mcp-pix
v0.1.1
Published
MCP server for PayZu Pix Processamento API. 29 tools: Pix charges, withdrawals, transfers, callbacks, MED infractions. Works with Claude Desktop, Cursor, Continue.
Maintainers
Readme
payzu-mcp-pix
MCP server for the PayZu Pix Processamento API. Plugs into Claude Desktop, Cursor, Continue, and any other MCP-compatible AI client to let the assistant call PayZu's Pix API directly with typed tools.
29 tools spanning Pix charges, withdrawals, internal transfers, account info, reports, callbacks and MED infractions. No admin endpoints exposed.
Install
Claude Desktop / Continue
Add to claude_desktop_config.json (~/Library/Application Support/Claude/ on macOS, %APPDATA%\Claude\ on Windows):
{
"mcpServers": {
"payzu-pix": {
"command": "npx",
"args": ["-y", "payzu-mcp-pix"],
"env": {
"PAYZU_TOKEN": "<your-bearer-token-from-dashboard>"
}
}
}
}Cursor
Add to .cursor/mcp.json in your project (or ~/.cursor/mcp.json globally):
{
"mcpServers": {
"payzu-pix": {
"command": "npx",
"args": ["-y", "payzu-mcp-pix"],
"env": { "PAYZU_TOKEN": "..." }
}
}
}Configuration
| Env var | Required | Default | Description |
|---|---|---|---|
| PAYZU_TOKEN | yes | — | Bearer token from abrirconta.payzu.com.br |
| PAYZU_API_URL | no | https://api.payzu.processamento.com/v1 | Override for whitelabel tenants |
Tools
Each tool description links to the corresponding endpoint page in docs.payzu.com.br.
Pix charges (4)
pix.create— POST /pixpix.get— GET /pixpix.qr_code— GET /pix/qr-code/{id}pix.proof— GET /proof/{id}
Withdrawals (6)
withdraw.create— POST /withdraw (by Pix key)withdraw.get— GET /withdrawwithdraw.by_qr— POST /withdraw/qrcodewithdraw.read_qr— POST /pix/qrcode/readwithdraw.dict— GET /pix-key/{key}withdraw.proof— GET /withdraw/proof/{id}
Internal transfer (2)
internal_transfer.create— POST /internal-transferinternal_transfer.get— GET /internal-transfer
Account (2)
account.profile— GET /useraccount.balance— GET /user/balance
Reports (6)
reports.list_transactions— GET /user/transactionsreports.get_transaction— GET /user/transactions/{id}reports.create_csv— POST /user/reportreports.list_jobs— GET /user/reportsreports.get_job— GET /user/report/{id}reports.download— GET /user/report/{id}/download
Callbacks (4)
callbacks.list— GET /user/callbackscallbacks.get— GET /user/callback/{id}callbacks.resend— POST /user/callback/{id}/resendcallbacks.resend_bulk— POST /user/callbacks/resend
MED Infractions (5)
infractions.list— GET /infractionsinfractions.get— GET /infractions/{id}infractions.create_defense— POST /infractions/{id}/defenseinfractions.list_defenses— GET /infractions/{id}/defensesinfractions.get_defense— GET /infractions/{id}/defense/{defenseId}
Conventions enforced
- Amounts always in BRL decimals (
99.90, not9990). The MCP rejects centavos at input validation. clientReferencerequired on all create operations for idempotency.callbackUrlrequired on creates so PayZu can notify when status changes.- Auto-retry on 5xx/429 with exponential backoff + jitter (3 attempts max).
- Errors include
requestId— log it and send to support if you need to investigate.
Custom base URL
If your account uses a custom Pix Processamento endpoint, override the default via env:
"env": {
"PAYZU_TOKEN": "<your-token>",
"PAYZU_API_URL": "https://api.example.processamento.com/v1"
}All 29 tools work identically against any compatible endpoint.
Links
- Documentation: https://docs.payzu.com.br/docs/pix-processamento
- OpenAPI: https://docs.payzu.com.br/openapi.json
- llms-full.txt: https://docs.payzu.com.br/pix-processamento/llms-full.txt
- SKILL.md (compact reference for AI): https://docs.payzu.com.br/pix-processamento/SKILL.md
- Issues: https://github.com/PayZuPlus/payzu-mcp/issues
- npm SDKs:
npm install payzu-pix
License
MIT
