Razorpay CLI

Command-line interface for the Razorpay API. Manage payments, orders, customers, invoices, refunds, settlements, disputes, payment links, QR codes, subscriptions, Route, and Smart Collect from your terminal.

Installation

Install the latest release for your platform:

curl -fsSL https://razorpay.com/cli/latest/install.sh | bash

The script downloads the right tarball for your OS/arch, extracts the razorpay binary, and places it at /usr/local/bin/razorpay. Confirm the install:

$ razorpay --version
razorpay version v1.0.8

Other options — Homebrew-style manual download, go install, building from source — are in docs/install.md.

Configuration

Run configure interactively. The current value (if any) appears in brackets and Enter keeps it. The secret is masked while you type.

$ razorpay configure
Razorpay Key ID [None]: rzp_test_1DP5mmOlF5G5ag
Razorpay Key Secret [None]:
Credentials saved to /Users/you/.razorpay/config.yaml

Or pass credentials non-interactively — any flag you omit is prompted for:

razorpay configure --key-id rzp_test_xxxxxxxxxxxx --key-secret xxxxxxxxxxxxxxxxxxxx

Credentials live in ~/.razorpay/config.yaml. Environment variables override the file:

export RAZORPAY_KEY_ID=rzp_test_xxxxxxxxxxxx
export RAZORPAY_KEY_SECRET=xxxxxxxxxxxxxxxxxxxx

Generate keys from the Razorpay Dashboard — rzp_test_ for development, rzp_live_ for production.

Examples

All amounts are in the smallest currency unit (paise for INR — 50000 = ₹500.00).

Create an order

$ razorpay orders create --amount 50000 --currency INR --receipt order-001
{
  "id": "order_RB58MiP5SPFYyM",
  "entity": "order",
  "amount": 50000,
  "amount_paid": 0,
  "amount_due": 50000,
  "currency": "INR",
  "receipt": "order-001",
  "status": "created",
  "attempts": 0,
  "notes": [],
  "created_at": 1756455561
}

Fetch an order

$ razorpay orders fetch order_RB58MiP5SPFYyM
{
  "id": "order_RB58MiP5SPFYyM",
  "entity": "order",
  "amount": 50000,
  "amount_paid": 0,
  "amount_due": 50000,
  "currency": "INR",
  "receipt": "order-001",
  "status": "created",
  "attempts": 0,
  "notes": [],
  "created_at": 1756455561
}

List recent payments

$ razorpay payments list --count 2
{
  "entity": "collection",
  "count": 2,
  "items": [
    {
      "id": "pay_29QQoUBi66xm2f",
      "entity": "payment",
      "amount": 50000,
      "currency": "INR",
      "status": "captured",
      "order_id": "order_RB58MiP5SPFYyM",
      "method": "card",
      "captured": true,
      "created_at": 1756455622
    },
    {
      "id": "pay_29QQjUNkbFbiY8",
      "entity": "payment",
      "amount": 12500,
      "currency": "INR",
      "status": "authorized",
      "order_id": "order_RAxxJYS92AKL8z",
      "method": "upi",
      "captured": false,
      "created_at": 1756342140
    }
  ]
}

Create a customer

$ razorpay customers create --name "Ada Lovelace" --email ada@example.com --contact 9876543210
{
  "id": "cust_1Aa00000000004",
  "entity": "customer",
  "name": "Ada Lovelace",
  "email": "ada@example.com",
  "contact": "9876543210",
  "gstin": null,
  "notes": [],
  "created_at": 1756455800
}

Create a payment link

$ razorpay payment-links create \
    --amount 30000 --currency INR \
    --customer-name "Ada Lovelace" --customer-email ada@example.com --customer-contact 9876543210 \
    --description "Invoice 0042" --reference-id INV-0042
{
  "id": "plink_LFhRgkn8nfx6vY",
  "entity": "payment_link",
  "amount": 30000,
  "currency": "INR",
  "status": "created",
  "short_url": "https://rzp.io/i/abc123",
  "reference_id": "INV-0042",
  "description": "Invoice 0042",
  "customer": {
    "name": "Ada Lovelace",
    "email": "ada@example.com",
    "contact": "9876543210"
  },
  "created_at": 1756455900
}

Errors

Errors are surfaced with the HTTP status and the API's response body, so they're easy to grep for in CI:

$ razorpay orders fetch order_does_not_exist
Error: API request failed with status 400: {"error":{"code":"BAD_REQUEST_ERROR","description":"The id provided does not exist"}}

Run razorpay <group> --help to list subcommands, or razorpay <group> <subcommand> --help for flags and examples.

Commands

Group	What it manages
configure	Save API credentials
payments	Payments — capture, card details, downtime, transfers
orders	Orders
customers	Customers
refunds	Refunds
invoices	Invoices and line items
payment-links	Payment Links
qr-codes	QR Codes
subscriptions	Subscriptions and plans
route	Route — linked accounts and transfers
smart-collect	Smart Collect — virtual accounts
settlements	Settlements and reconciliation
disputes	Disputes
documents	Documents

Repository layout

cmd/
  <resource>/        one package per resource (payments, orders, ...)
    <resource>.go      parent Cmd + subcommand registration
    <subcommand>.go    one file per subcommand (list.go, fetch.go, ...)
  cmdutil/           shared client + error helpers
  configure.go       `configure` command (lives in package cmd directly)
  root.go            root command + subpackage wiring
api/                 HTTP client — auth, JSON pretty-print, multipart upload
config/              config file + env-var loader (viper)
tests/               end-to-end test suite (build tag `e2e`)
docs/                per-resource usage guides
install.sh           platform installer
AGENTS.md            agent guidance for this repo
CHANGELOG.md         release notes

To add a subcommand to an existing resource, drop a new file into cmd/<resource>/ and register it on Cmd inside that package's <resource>.go. To add a new top-level resource, mirror an existing folder and add rootCmd.AddCommand(<pkg>.Cmd) in cmd/root.go.

Build and test

Every dev workflow has a make target — prefer those over invoking go directly so flags, build tags, and lint versions stay in one place.

make setup                # download Go module dependencies
make build                # compile the razorpay binary (output in ./razorpay)
make build-all-platforms  # cross-compile for darwin / linux / windows
make fmt                  # gofmt -s every .go file
make lint                 # run golangci-lint (auto-installs the pinned version)
make test                 # run the end-to-end suite against the live API
make ci                   # build + test + lint + go mod tidy check
make clean                # remove build artefacts

The end-to-end suite lives in tests/ and is gated by the e2e build tag. make test exits with a non-zero status unless RAZORPAY_KEY_ID and RAZORPAY_KEY_SECRET are exported in the environment:

export RAZORPAY_KEY_ID=rzp_test_xxxxxxxxxxxx
export RAZORPAY_KEY_SECRET=xxxxxxxxxxxxxxxxxxxx
make test

See tests/README.md for the layout of the test suite and how each resource is exercised.

Documentation

• docs/install.md — platform-specific install
• Per-resource guides: payments · orders · customers · refunds · settlements · disputes
• CHANGELOG.md — release notes
• AGENTS.md — agent guidance for working in this repository