Package Exports
- @vonpay/checkout-cli
Readme
@vonpay/checkout-cli
Command-line tools for developers integrating with Von Payments Checkout. Create test sessions, inspect session state, trigger webhook events, and bootstrap local integration work.
Install
npm install -g @vonpay/checkout-cliRequires: Node 20+.
Login
Save your Von Payments API key once:
vonpay checkout loginStores credentials at ~/.vonpay/config.json. Use a test-mode key (vp_sk_test_...) for local development.
Commands
All commands are namespaced under vonpay checkout:
| Command | Purpose |
|---|---|
vonpay checkout login |
Save API key to ~/.vonpay/config.json |
vonpay checkout init |
Scaffold a minimal checkout integration starter |
vonpay checkout sessions list |
List recent checkout sessions |
vonpay checkout sessions create |
Create a test checkout session and print the URL |
vonpay checkout sessions get <id> |
Fetch session details |
vonpay checkout trigger <event> |
Trigger a synthetic webhook event against your local endpoint |
vonpay checkout health |
Check Von Payments API health and latency |
Run vonpay checkout --help for the full flag reference.
Quick start
# One-time setup
vonpay checkout login
# Create a test session
vonpay checkout sessions create --amount 1499 --currency USD --country US
# Trigger a payment.succeeded webhook against localhost:3000
vonpay checkout trigger payment.succeeded --url http://localhost:3000/webhooks/vonpayDocumentation
License
MIT