CLI

The Paysio CLI does everything the dashboard does — products, payment links, invoices, customers, subscriptions, transactions and refunds, disputes, balances and payouts, webhooks, team members, settings, and the production applications — from a terminal. It is built to be driven either by a human or by an AI agent, so every command is fully non-interactive when you ask it to be.

Install

npm install -g paysio

paysio login          # opens your browser to authorize this terminal
paysio use my-store   # choose the workspace to work in
paysio balance

Requires Node 18 or newer. Standalone binaries for macOS and Windows are available if you would rather not install through npm.

Authentication

paysio login opens your browser, shows a short code, and asks you to approve that terminal. The session belongs to your user and inherits your workspace role, so the CLI can never do more than you can in the dashboard. Sessions are listed and revocable under Settings → API keys.

• paysio login --email signs in with an emailed code instead, for machines with no browser.
• PAYSIO_API_KEY=sk_live_... uses a secret API key instead of a session. That key authenticates the public V1 API only, so commands outside it fail with a clear message rather than a confusing 401.
• paysio logout revokes the session on the server as well as locally.

Test and live mode

Every workspace has a test and a live mode, exactly like the dashboard toggle. A fresh login starts in test. Check with paysio mode, switch with paysio mode live, or override a single command with --live / --test.

Confirmations

There are two tiers, and they behave differently on purpose.

Live money and account destruction. transactions refund, transactions void, transactions cancel, payouts send, money add, money withdraw, payout-links create, payout-requests approve, disputes accept, disputes refund, disputes submit, campaigns send, apply high-risk and workspaces delete. In live mode you retype the amount (or the workspace slug) interactively, or pass --confirm when there is no terminal. --yes does not work here and that is deliberate. In test mode these fall back to a plain yes/no question.

Everything else destructive. Deletes, removals and one-way replacements — api-keys revoke, webhooks delete, webhooks rotate-secret, payment-links delete, payout-links delete, payout-requests reject, invoices send, invoices void, subscriptions cancel, members remove, domain remove, campaigns cancel, campaigns delete, email-templates delete, subscribers remove, products variants, store restore, store templates apply and fulfillments cancel — ask a yes/no question that --yes skips.

Global flags

These work on every command, before or after the subcommand.

Using it from a script or an agent

Pass --json to any command. It prints machine-readable JSON on stdout, turns off colour, and never prompts — a command missing required input fails with a structured error instead of hanging. Human status lines go to stderr, so paysio ... --json > out.json is always clean JSON.

paysio transactions list --status failed --limit 20 --json
paysio products create --name "Coaching call" --price 149 --json
paysio transactions refund txn_123 --amount 25.00 --confirm --json

Exit codes let a script branch without parsing text:

The webhook development loop

paysio listen streams your workspace’s events to the terminal and, optionally, forwards each one to a local URL with a real Paysio-Signature header, so the handler you are writing verifies signatures exactly as it will in production. It works even when you have no webhook endpoints configured.

# terminal 1 - prints a signing secret, then forwards events
paysio listen --forward-to localhost:3000/webhooks

# terminal 2 - creates a REAL sandbox charge so the event actually fires
paysio trigger payment.completed

paysio trigger does not fabricate payloads. Each fixture drives the real API to create genuine sandbox objects, so every downstream effect — webhooks, ledger entries, emails — happens the way it will in production. Run paysio trigger --list to see the built-in fixtures, or pass your own with --fixture ./flow.json. It refuses to run in live mode.

AI agents

The CLI ships with a Model Context Protocol server and a Claude Code skill, so an agent can operate a Paysioaccount with the same guardrails a human gets.

paysio mcp add claude-code    # or: claude, cursor
paysio skills add             # installs the Paysio skill for Claude Code
paysio agent-context --json   # one-call briefing: workspace, mode, balance, activity
paysio --llms                 # machine-readable manifest of every command

The MCP server exposes a curated tool set rather than raw shell access: paysio_context, paysio_list, paysio_get, paysio_create, paysio_action, paysio_describe, paysio_apply_debit_payouts and paysio_api. Tools that move money refuse to execute in live mode unless the caller passes confirm: true, which the skill instructs the agent to obtain from you first.

Applying for production

The Paysio Debit & Payouts application can be completed entirely from the terminal, which is the flow most worth handing to an agent.

paysio apply debit-payouts                 # 6-step guided wizard
paysio apply debit-payouts --template      # or a JSON skeleton for scripts
paysio apply debit-payouts --file app.json --dry-run   # field-level validation
paysio apply debit-payouts --file app.json             # submit
paysio apply status

--dry-run returns { valid, errors: [{ field, message }] } so an agent can fix the file and retry without touching the server. The high-risk (NMI) application works the same way through paysio apply high-risk, with --documents to upload supporting files and --signature for the signer’s signature image.

Raw API access

When no command fits, call the API directly with your existing session. This is the escape hatch that keeps an agent from ever being blocked.

paysio api GET /api/products --query workspace_id=ws_123 --json
paysio api POST /api/v1/charges --data @charge.json --json

Command reference

Every command below is real and current. Add --help to any group to see its flags (paysio invoices --help), or run paysio --llms for the same tree as JSON, which is what you should hand an agent rather than pasting this page.

Session and navigation

Products and catalog

Storefront

Selling

Customers

Transactions and orders

Disputes and chargebacks

Balance and money out

Email marketing

Developer tools

Apps

Workspace, team and settings

Configuration

Drop a paysio.json in a project to pin the workspace and mode for everyone working in it, so nobody runs a command against the wrong account:

{ "workspace": "my-store", "mode": "test" }

Security

• The session token is stored in ~/.paysio/credentials.json with owner-only permissions and is never printed.
• The CLI cannot accept a card number. Keyed payments stay in the dashboard virtual terminal, which keeps your terminal out of PCI scope.
• Secrets such as SSNs and bank account numbers are collected through masked prompts, never as flags that would land in your shell history.
• No telemetry. The CLI does not report what you run.