mcp-charge-pix（MCP charge PIX 命令行）

Kobana Pix Creation via MCP

Create Pix charges using the kobana-mcp-charge MCP server tools.

Prerequisites

The kobana-mcp-charge MCP server must be configured. See MCP Server Setup below.

Available MCP Tools

Pix Accounts

Pix Charges

Creating a Pix Charge

Step 1: Get the Pix Account UID

First, list available Pix accounts to get the pix_account_uid:

Use tool: list_charge_pix_accounts

Step 2: Create the Pix Charge

Use the create_charge_pix tool with the required parameters:

Instant Pix (e-commerce, delivery):

{
  "amount": 150.00,
  "pix_account_uid": "018df180-7208-727b-...",
  "expire_at": "2026-01-31T12:30:00-03:00",
  "registration_kind": "instant",
  "payer": {
    "document_number": "111.321.322-09",
    "name": "João da Silva"
  },
  "external_id": "order_12345"
}

Billing Pix (invoices, subscriptions):

{
  "amount": 500.00,
  "pix_account_uid": "018df180-7208-727b-...",
  "expire_at": "2026-02-10T23:59:59-03:00",
  "registration_kind": "billing",
  "payer": {
    "document_number": "12.345.678/0001-90",
    "name": "Company LTDA"
  },
  "fine_type": "percentage",
  "fine_percentage": 2.0,
  "interest_type": "monthly_percentage_calendar",
  "interest_percentage": 1.0,
  "revoke_days": 30
}

Step 3: Get the QR Code

The initial response may not contain the QR Code (asynchronous registration). To get it:

1. Poll the charge using get_charge_pix with the returned UID
2. Check registration_status: When it's confirmed, the qrcode field will be populated

Use tool: get_charge_pix
Parameters: { "uid": "019c0cbe-f018-717e-..." }

Common Parameters

Required

Payer Data

Fine and Interest (Billing Pix only)

Tracking

Pix Types

Instant Pix (registration_kind: "instant")

• Short expiration (minutes to hours)
• No interest, fines, or discounts
• Use for: e-commerce, delivery, point-of-sale

Billing Pix (registration_kind: "billing")

• Formal due date
• Supports interest, fines, discounts
• Stays active after due date (if revoke_days set)
• Use for: monthly invoices, subscriptions

Status Reference

Charge Status

• opened - Open (initial)
• paid - Paid
• overdue - Overdue
• canceled - Canceled

Registration Status

• pending - Waiting for registration
• confirmed - Ready (has QR Code)
• rejected / failed - Error

MCP Server Setup

Claude Desktop Configuration

Add to ~/Library/Application Support/Claude/claude_desktop_config.json (macOS) or %APPDATA%\Claude\claude_desktop_config.json (Windows):

{
  "mcpServers": {
    "kobana-charge": {
      "command": "npx",
      "args": ["-y", "kobana-mcp-charge"],
      "env": {
        "KOBANA_ACCESS_TOKEN": "your_access_token"
      }
    }
  }
}

Sandbox Environment

{
  "mcpServers": {
    "kobana-charge": {
      "command": "npx",
      "args": ["-y", "kobana-mcp-charge"],
      "env": {
        "KOBANA_ACCESS_TOKEN": "your_sandbox_token",
        "KOBANA_API_URL": "https://api-sandbox.kobana.com.br"
      }
    }
  }
}

Claude Code Configuration

Add to .mcp.json in your project root:

{
  "mcpServers": {
    "kobana-charge": {
      "command": "npx",
      "args": ["-y", "kobana-mcp-charge"],
      "env": {
        "KOBANA_ACCESS_TOKEN": "your_access_token"
      }
    }
  }
}

Remote MCP (Hosted)

{
  "mcpServers": {
    "kobana-charge": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-remote",
        "https://mcp.kobana.com.br/charge/mcp",
        "--header",
        "Authorization: Bearer your_access_token"
      ]
    }
  }
}

Best Practices

1. Always get the Pix Account first - Use list_charge_pix_accounts to get available accounts
2. Poll for QR Code - Use get_charge_pix to check registration status
3. Use external_id - Track charges in your system
4. Set revoke_days - Required for interest/fines on Billing Pix
5. Validate CPF/CNPJ - Before creating the charge
6. Test in sandbox - Configure sandbox environment first

Reference Documentation

See references/REFERENCE.md for complete MCP server documentation and all available tools.