ZevPay CLI

Command-line tool for ZevPay Checkout. Manage payments, test webhooks, and verify transactions from your terminal.

Installation

npm install -g @zevpay/cli

Or use without installing:

npx @zevpay/cli <command>

Quick start

# Authenticate
zevpay login sk_test_your_secret_key

# Save webhook secret (for listen/trigger)
zevpay webhook-secret whsec_your_secret

# Check your balance
zevpay balance

# Verify a payment
zevpay verify ses_abc123

# List banks
zevpay banks

# Resolve a bank account
zevpay resolve 0123456789 044

Commands

zevpay login <secret_key>

Authenticate with your ZevPay secret key. The key is stored locally.

zevpay login sk_test_abc123
# Authenticated successfully (test mode).

You can also set the ZEVPAY_SECRET_KEY environment variable instead.

zevpay logout

Remove stored API keys.

zevpay webhook-secret <secret>

Save your webhook signing secret for listen and trigger commands.

zevpay verify <session_id>

Verify a checkout session and display its status.

zevpay verify ses_abc123
zevpay verify ses_abc123 --json

zevpay banks

List all supported banks.

zevpay banks
zevpay banks --search access
zevpay banks --json

zevpay resolve <account_number> <bank_code>

Resolve a bank account (name enquiry).

zevpay resolve 0123456789 044

zevpay balance

Show your wallet balance.

zevpay balance
zevpay balance --json

zevpay listen

Start a local HTTP server that receives webhook events. Add the URL to your ZevPay Dashboard.

zevpay listen                              # Listen on port 4242
zevpay listen -p 8080                      # Custom port
zevpay listen -f http://localhost:3000/api/webhooks  # Forward to your app

Events are verified using your webhook secret and displayed in real-time:

  ZevPay Webhook Listener

  Endpoint  http://localhost:4242/
  Status    Ready — waiting for events

  ->  3/11/2026, 2:30:00 PM  charge.success  [sig verified]
      ref=TEST-A1B2C3D4  amount=500000  status=completed

zevpay trigger <event>

Send a test webhook event with a valid signature.

zevpay trigger charge.success                        # To localhost:4242
zevpay trigger transfer.success -u http://localhost:3000/webhooks

Available events: charge.success, transfer.success, transfer.failed, transfer.reversed, invoice.created, invoice.paid.

Environment variables

| Variable | Description | |----------|-------------| | ZEVPAY_SECRET_KEY | API secret key (alternative to zevpay login) | | ZEVPAY_WEBHOOK_SECRET | Webhook signing secret (alternative to zevpay webhook-secret) |

License

MIT