Skip to content

razorpay/razorpay-mcp-server

Repository files navigation

Razorpay MCP Server (Official)

The Razorpay MCP Server is a Model Context Protocol (MCP) server that provides seamless integration with Razorpay APIs, enabling advanced payment processing capabilities for developers and AI tools.

Quick Start

Choose your preferred setup method:

Available Tools

Currently, the Razorpay MCP Server provides the following tools:

Tool Description API Remote Server Support
capture_payment Change the payment status from authorized to captured. Payment âś…
fetch_payment Fetch payment details with ID Payment âś…
fetch_payment_card_details Fetch card details used for a payment Payment âś…
fetch_all_payments Fetch all payments with filtering and pagination Payment âś…
update_payment Update the notes field of a payment Payment âś…
create_payment_link Creates a new payment link (standard) Payment Link âś…
create_payment_link_upi Creates a new UPI payment link Payment Link âś…
fetch_all_payment_links Fetch all the payment links Payment Link âś…
fetch_payment_link Fetch details of a payment link Payment Link âś…
send_payment_link Send a payment link via SMS or email. Payment Link âś…
update_payment_link Updates a new standard payment link Payment Link âś…
create_order Creates an order Order âś…
fetch_order Fetch order with ID Order âś…
fetch_all_orders Fetch all orders Order âś…
update_order Update an order Order âś…
fetch_order_payments Fetch all payments for an order Order âś…
create_refund Creates a refund Refund ❌
fetch_refund Fetch refund details with ID Refund âś…
fetch_all_refunds Fetch all refunds Refund âś…
update_refund Update refund notes with ID Refund âś…
fetch_multiple_refunds_for_payment Fetch multiple refunds for a payment Refund âś…
fetch_specific_refund_for_payment Fetch a specific refund for a payment Refund âś…
create_qr_code Creates a QR Code QR Code âś…
fetch_qr_code Fetch QR Code with ID QR Code âś…
fetch_all_qr_codes Fetch all QR Codes QR Code âś…
fetch_qr_codes_by_customer_id Fetch QR Codes with Customer ID QR Code âś…
fetch_qr_codes_by_payment_id Fetch QR Codes with Payment ID QR Code âś…
fetch_payments_for_qr_code Fetch Payments for a QR Code QR Code âś…
close_qr_code Closes a QR Code QR Code ❌
fetch_all_settlements Fetch all settlements Settlement âś…
fetch_settlement_with_id Fetch settlement details Settlement âś…
fetch_settlement_recon_details Fetch settlement reconciliation report Settlement âś…
create_instant_settlement Create an instant settlement Settlement ❌
fetch_all_instant_settlements Fetch all instant settlements Settlement âś…
fetch_instant_settlement_with_id Fetch instant settlement with ID Settlement âś…
fetch_all_payouts Fetch all payout details with A/c number Payout âś…
fetch_payout_by_id Fetch the payout details with payout ID Payout âś…

Use Cases

  • Workflow Automation: Automate your day to day workflow using Razorpay MCP Server.
  • Agentic Applications: Building AI powered tools that interact with Razorpay's payment ecosystem using this Razorpay MCP server.

Remote MCP Server (Recommended)

The Remote MCP Server is hosted by Razorpay and provides instant access to Razorpay APIs without any local setup. This is the recommended approach for most users.

Benefits of Remote MCP Server

  • Zero Setup: No need to install Docker, Go, or manage local infrastructure
  • Always Updated: Automatically stays updated with the latest features and security patches
  • High Availability: Backed by Razorpay's robust infrastructure with 99.9% uptime
  • Reduced Latency: Optimized routing and caching for faster API responses
  • Enhanced Security: Secure token-based authentication with automatic token rotation
  • No Maintenance: No need to worry about updates, patches, or server maintenance

Prerequisites

npx is needed to use mcp server. You need to have Node.js installed on your system, which includes both npm (Node Package Manager) and npx (Node Package Execute) by default:

macOS

# Install Node.js (which includes npm and npx) using Homebrew
brew install node

# Alternatively, download from https://nodejs.org/

Windows

# Install Node.js (which includes npm and npx) using Chocolatey
choco install nodejs

# Alternatively, download from https://nodejs.org/

Verify Installation

npx --version

Usage with Cursor

Inside your cursor settings in MCP, add this config.

{
  "mcpServers": {
    "rzp-sse-mcp-server": {
      "command": "npx",
      "args": [
        "mcp-remote",
        "https://mcp.razorpay.com/sse",
        "--header",
        "Authorization:${AUTH_HEADER}"
      ],
      "env": {
        "AUTH_HEADER": "Bearer <Base64(key:secret)>"
      }
    }
  }
}

Replace key & secret with your Razorpay API KEY & API SECRET

Usage with Claude Desktop

Add the following to your claude_desktop_config.json:

{
  "mcpServers": {
    "rzp-sse-mcp-server": {
      "command": "npx",
      "args": [
        "mcp-remote",
        "https://mcp.razorpay.com/sse",
        "--header",
        "Authorization: Bearer <Merchant Token>"
      ]
    }
  }
}

Replace <Merchant Token> with your Razorpay merchant token. Check Authentication section for steps to generate token.

  • Learn about how to configure MCP servers in Claude desktop: Link
  • How to install Claude Desktop: Link

Usage with VS Code

Add the following to your VS Code settings (JSON):

{
  "mcp": {
    "inputs": [
      {
        "type": "promptString",
        "id": "merchant_token",
        "description": "Razorpay Merchant Token",
        "password": true
      }
    ],
    "servers": {
      "razorpay-remote": {
        "command": "npx",
        "args": [
          "mcp-remote",
          "https://mcp.razorpay.com/sse",
          "--header",
          "Authorization: Bearer ${input:merchant_token}"
        ]
      }
    }
  }
}

Learn more about MCP servers in VS Code's agent mode documentation.

Authentication

The Remote MCP Server uses merchant token-based authentication. To generate your merchant token:

  1. Go to the Razorpay Dashboard and navigate to Settings > API Keys

  2. Locate your API Key and API Secret:

    • API Key is visible on the dashboard
    • API Secret is generated only once when you first create it. Important: Do not generate a new secret if you already have one
  3. Generate your merchant token by running this command in your terminal:

    echo <RAZORPAY_API_KEY>:<RAZORPAY_API_SECRET> | base64

    Replace <RAZORPAY_API_KEY> and <RAZORPAY_API_SECRET> with your actual credentials

  4. Copy the base64-encoded output - this is your merchant token for the Remote MCP Server

Note: For local MCP Server deployment, you can use the API Key and Secret directly without generating a merchant token.

Local MCP Server

For users who prefer to run the MCP server on their own infrastructure or need access to all tools (including those restricted in the remote server), you can deploy the server locally.

Prerequisites

  • Docker
  • Golang (Go)
  • Git

To run the Razorpay MCP server, use one of the following methods:

Using Public Docker Image (Recommended)

You can use the public Razorpay image directly. No need to build anything yourself - just copy-paste the configurations below and make sure Docker is already installed.

Note: To use a specific version instead of the latest, replace razorpay/mcp with razorpay/mcp:v1.0.0 (or your desired version tag) in the configurations below. Available tags can be found on Docker Hub.

Usage with Claude Desktop

This will use the public razorpay image

Add the following to your claude_desktop_config.json:

{
    "mcpServers": {
        "razorpay-mcp-server": {
            "command": "docker",
            "args": [
                "run",
                "--rm",
                "-i",
                "-e",
                "RAZORPAY_KEY_ID",
                "-e",
                "RAZORPAY_KEY_SECRET",
                "razorpay/mcp"
            ],
            "env": {
                "RAZORPAY_KEY_ID": "your_razorpay_key_id",
                "RAZORPAY_KEY_SECRET": "your_razorpay_key_secret"
            }
        }
    }
}

Please replace the your_razorpay_key_id and your_razorpay_key_secret with your keys.

  • Learn about how to configure MCP servers in Claude desktop: Link
  • How to install Claude Desktop: Link

Usage with VS Code

Add the following to your VS Code settings (JSON):

{
    "mcpServers": {
        "razorpay-mcp-server": {
            "command": "docker",
            "args": [
                "run",
                "--rm",
                "-i",
                "-e",
                "RAZORPAY_KEY_ID",
                "-e",
                "RAZORPAY_KEY_SECRET",
                "razorpay/mcp"
            ],
            "env": {
                "RAZORPAY_KEY_ID": "your_razorpay_key_id",
                "RAZORPAY_KEY_SECRET": "your_razorpay_key_secret"
            }
        }
    }
}

Please replace the your_razorpay_key_id and your_razorpay_key_secret with your keys.

  • Learn about how to configure MCP servers in Claude desktop: Link
  • How to install Claude Desktop: Link

Usage with VS Code

Add the following to your VS Code settings (JSON):

{
  "mcp": {
    "inputs": [
      {
        "type": "promptString",
        "id": "razorpay_key_id",
        "description": "Razorpay Key ID",
        "password": false
      },
      {
        "type": "promptString",
        "id": "razorpay_key_secret",
        "description": "Razorpay Key Secret",
        "password": true
      }
    ],
    "servers": {
      "razorpay": {
        "command": "docker",
        "args": [
          "run",
          "-i",
          "--rm",
          "-e",
          "RAZORPAY_KEY_ID",
          "-e",
          "RAZORPAY_KEY_SECRET",
          "razorpay/mcp"
        ],
        "env": {
          "RAZORPAY_KEY_ID": "${input:razorpay_key_id}",
          "RAZORPAY_KEY_SECRET": "${input:razorpay_key_secret}"
        }
      }
    }
  }
}

Learn more about MCP servers in VS Code's agent mode documentation.

Build from Docker (Alternative)

You need to clone the Github repo and build the image for Razorpay MCP Server using docker. Do make sure docker is installed and running in your system.

# Run the server
git clone https://github.com/razorpay/razorpay-mcp-server.git
cd razorpay-mcp-server
docker build -t razorpay-mcp-server:latest .

Once the razorpay-mcp-server:latest docker image is built, you can replace the public image(razorpay/mcp) with it in the above configurations.

Build from source

You can directly build from the source instead of using docker by following these steps:

# Clone the repository
git clone https://github.com/razorpay/razorpay-mcp-server.git
cd razorpay-mcp-server

# Build the binary
go build -o razorpay-mcp-server ./cmd/razorpay-mcp-server

Once the build is ready, you need to specify the path to the binary executable in the command option. Here's an example for VS Code settings:

{
  "razorpay": {
    "command": "/path/to/razorpay-mcp-server",
    "args": ["stdio","--log-file=/path/to/rzp-mcp.log"],
    "env": {
      "RAZORPAY_KEY_ID": "<YOUR_ID>",
      "RAZORPAY_KEY_SECRET" : "<YOUR_SECRET>"
    }
  }
}

Configuration

The server requires the following configuration:

  • RAZORPAY_KEY_ID: Your Razorpay API key ID
  • RAZORPAY_KEY_SECRET: Your Razorpay API key secret
  • LOG_FILE (optional): Path to log file for server logs
  • TOOLSETS (optional): Comma-separated list of toolsets to enable (default: "all")
  • READ_ONLY (optional): Run server in read-only mode (default: false)

Command Line Flags

The server supports the following command line flags:

  • --key or -k: Your Razorpay API key ID
  • --secret or -s: Your Razorpay API key secret
  • --log-file or -l: Path to log file
  • --toolsets or -t: Comma-separated list of toolsets to enable
  • --read-only: Run server in read-only mode

Debugging the Server

You can use the standard Go debugging tools to troubleshoot issues with the server. Log files can be specified using the --log-file flag (defaults to ./logs)

License

This project is licensed under the terms of the MIT open source license. Please refer to LICENSE for the full terms.

About

Razorpay's Official MCP Server

Topics

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Packages

No packages published

Languages