# Paytm MCP Server

Paytm MCP Server enables AI agents and developers to securely access Paytm's Payments and Business Payments APIs via the Model Context Protocol (MCP). It allows smart, contextual automation across all payment workflows

## Features

- **Smart Payment Ops**: Automate routine payment workflows like refunds, settlement tracking, and transaction status checks using AI agents powered by Paytm MCP

- **Context-Aware AI Assistants**: Create intelligent tools that can fetch and explain transactions, initiate payouts, or manage payment links—all through simple natural language prompts

- **Developer Productivity**: Supercharge developer efficiency by enabling Paytm API calls (e.g. "Create a ₹500 payment link") directly via terminals, chat-based UIs, or AI IDE plugins

- **Agentic AI Payments**: Enable agentic AI payments, build enhanced bot led shopping experience through Paytm MCP server

## Tools

| Tool                | Description                          | API                                                                                                         |
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------------- |
| `create_link`       | Create a new payment link            | [Create Link API](https://www.paytmpayments.com/docs/api/create-link-api?ref=paymentLinks)                  |
| `fetch_link`        | Fetch details of a payment link      | [Fetch Link API](https://www.paytmpayments.com/docs/api/fetch-link-api?ref=paymentLinks)                    |
| `fetch_transaction` | Fetch transaction details for a link | [Fetch Transaction API](https://www.paytmpayments.com/docs/api/fetch-transaction-link-api?ref=paymentLinks) |

## Prerequisites

- [Python 3.12](https://www.python.org/downloads/) or higher
- [Paytm Merchant credentials](https://www.paytmpayments.com//docs/getting-started): `PAYTM_MID` and `PAYTM_KEY_SECRET`
- [uv](https://github.com/astral-sh/uv) (a fast Python package installer and runner)
- [Claude Desktop](https://www.anthropic.com/claude) (for running and managing the server)

## Installations

### Option 1: Automated Setup (Recommended)

1. Download the setup.sh script above for automated installation and configuration and follow the below steps:

2. Run the following in your terminal (Mac/Unix-based):

### Make the script executable

```bash
# Make the script executable
chmod +x setup.sh

# Run the setup script
./setup.sh
```

The script will:

1. Check for required dependencies (Python 3.12+, uv, Claude Desktop)
2. Clone or update the repository
3. Create and activate a virtual environment
4. Install all required dependencies
5. Create a .env file template for Paytm credentials

Note: On Windows, use Git Bash or WSL to run the script, or follow manual installation.

### Option 2: Manual Installation

1. **Clone the repository:**

   ```bash
   git clone https://github.com/paytm/payment-mcp-server.git
   cd payment-mcp-server
   ```

2. **Create and activate a virtual environment:**

   ```bash
   uv venv
   source .venv/bin/activate
   ```

3. **Install dependencies:**
   ```bash
   uv pip install .
   ```

## Running the MCP Server with Claude Desktop

This server is designed to be launched and managed through Claude Desktop. You do not need to run the server manually from the command line.

### Sample `claude_desktop_config.json`

Place this file in your project root or as required by Claude Desktop:

```json
{
  "mcpServers": {
    "paytm-mcp-server": {
      "command": "uv path",
      "args": ["--directory", "path to project", "run", "paytm_mcp.py"],
      "env": {
        "PAYTM_MID": "****************",
        "PAYTM_KEY_SECRET": "************"
      }
    }
  }
}
```

## Tips:

1. On Mac:

   - Run `which uv` to get the command path
   - Run `pwd` to get the project path

2. On Windows:

   - Run `where uv` to get the command path
   - Run `cd` to get the project path

   Ensure the paytm_mcp.py file exists in the given path.

3. The env section should contain your actual Paytm credentials (Paytm MID and Paytm Key Secret)

## Next Steps

1. Update the claude_desktop_config.json with your Paytm credentials
2. Restart the server using Claude Desktop
3. Begin interacting with Paytm APIs using your AI agents

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

The MIT License is a permissive license that allows you to:

- Use the code commercially
- Modify the code
- Distribute the code
- Use the code privately
- Sublicense the code

The only requirement is that the license and copyright notice must be included in all copies or substantial portions of the software.

Need help? Raise an issue or explore the [Paytm Documentation](https://www.paytmpayments.com/docs)