@ktmcp-cli/govukpay
v1.0.0
Published
Production-ready CLI for UK Government payments platform API
Downloads
43
Maintainers
Readme
"Six months ago, everyone was talking about MCPs. And I was like, screw MCPs. Every MCP would be better as a CLI."
— Peter Steinberger, Founder of OpenClaw Watch on YouTube (~2:39:00) | Lex Fridman Podcast #491
GOV.UK Pay CLI
Warning: Unofficial CLI - Not officially sponsored or affiliated with the UK Government Digital Service.
Command-line interface for the GOV.UK Pay API — the UK government's payments platform. Create and manage payments, refunds, and disputes from your terminal.
Installation
npm install -g @ktmcp-cli/govukpaySetup
govukpay config set --api-key <your-api-key>Get your API key from the GOV.UK Pay console.
Commands
Config
govukpay config set --api-key <key>
govukpay config showPayments
# Create a payment
govukpay payments create \
--amount 1000 \
--reference "order-001" \
--description "Service payment" \
--return-url "https://example.com/return"
# Get a payment
govukpay payments get <payment-id>
# Search payments
govukpay payments search
govukpay payments search --state success
govukpay payments search --reference "order-001"
govukpay payments search --from 2024-01-01 --to 2024-12-31
# Cancel or capture
govukpay payments cancel <payment-id>
govukpay payments capture <payment-id>
# View event history
govukpay payments events <payment-id>Refunds
govukpay refunds create <payment-id> --amount 500
govukpay refunds list <payment-id>
govukpay refunds get <payment-id> <refund-id>Disputes
govukpay disputes list
govukpay disputes list --state needs_response
govukpay disputes list --from 2024-01-01JSON Output
All commands support --json for structured output:
govukpay payments search --state success --json
govukpay refunds list <payment-id> --json
govukpay disputes list --jsonNotes
- Amounts are in pence (e.g. 1000 = £10.00)
- Payment states: created, started, submitted, success, failed, cancelled, error
- Dispute states: needs_response, under_review, won, lost
License
MIT
