tehwave/quickpay-cli

A command-line client for the Quickpay API.

Maintainers

Package info

github.com/tehwave/quickpay-cli

Type:project

pkg:composer/tehwave/quickpay-cli

Transparency log

Statistics

Installs: 3

Dependents: 0

Suggesters: 0

Stars: 0

Open Issues: 0

0.1.0 2026-08-09 20:28 UTC

This package is auto-updated.

Last update: 2026-08-09 20:35:49 UTC


README

Quality PHP 8.4+ License: MIT

Manage Quickpay payments and test callbacks from your terminal.

Create payment links, manage payments through the Quickpay API, use JSON output in scripts or for agents, and receive signed callbacks on localhost without a tunnel.

Features

  • 🔁 Watch Quickpay payment activity and relay signed callbacks to localhost. No tunnel or public development server required.
  • Create payments and hosted payment links.
  • List, filter, and inspect payments and their operations.
  • Capture, refund, and cancel payments.
  • Call any Quickpay API v10 endpoint.
  • Script- and agent-friendly, with JSON output and non-interactive options.

⭐ If you like Quickpay CLI, star it on GitHub. It helps a lot!

Installation

Quickpay CLI requires PHP 8.4 or newer.

composer global require tehwave/quickpay-cli

Install the bundled skill for coding agents:

skills add tehwave/quickpay-cli

Authenticate with a Quickpay merchant API key:

quickpay login

For automation, supply the API key through QUICKPAY_API_KEY.

Usage

quickpay list

Use --help to explore any command and its options:

quickpay callbacks:watch --help

Watch for callbacks and relay them

quickpay callbacks:watch --to=http://127.0.0.1:8000/quickpay/callback

Leave the watcher running while testing the payment flow. It signs and sends payment updates to your local callback handler.

With no selector, the watcher forwards new operation callbacks for every payment changed after it becomes ready. Pass a payment ID or --order-id to narrow the watch to one payment. Existing operations are not replayed. The watcher runs in the foreground and has no JSON mode.

quickpay callbacks:replay <payment-id> --to=<corrected-url>

Development

composer install
composer check
composer verify

composer check runs tests, static analysis, and formatting checks. composer verify additionally enforces coverage, validates package metadata, and audits the locked dependencies. The test suite uses HTTP fakes and does not contact Quickpay API.

Build an ignored development PHAR when packaging behavior changes:

composer build
builds/quickpay --version
builds/quickpay list --raw

The PHAR is a generated release artifact, not repository source. Versioned release artifacts are built with composer release:build -- 1.0.0.

See CONTRIBUTING.md before changing commands or security behavior.

Maintainers should follow RELEASING.md for versioned releases.

Security

Quickpay CLI keeps API keys out of command arguments and asks for confirmation before changing a payment.

See SECURITY.md to report a vulnerability. Never include credentials or merchant data in an issue.

Credits

Created and maintained by Peter 🌊 Jørgensen.

Built with Laravel Zero and released under the MIT License.

Quickpay CLI is an independent open-source project. It is not affiliated with or endorsed by Quickpay.