CLI Overview

Install and use the ZendFi CLI to manage payments, API keys, webhooks, and more from your terminal.

The ZendFi CLI gives you full control over your payment infrastructure without leaving your terminal. Create payments, manage API keys, test webhooks locally, and scaffold new projects in seconds.

Installation

npm

npm install -g @zendfi/cli

Verify the installation:

zendfi --version

Scaffolding Tool

To create a brand new ZendFi project from a template, use the companion scaffolding package:

npx create-zendfi-app my-store

This is a separate entry point that wraps the create command with interactive prompts. More details in the Init and Create reference.

Authentication

The CLI reads your API key from the ZENDFI_API_KEY environment variable. Set it before running commands:

export ZENDFI_API_KEY=zfi_test_your_key_here

Or add it to your shell profile (~/.bashrc, ~/.zshrc) for persistence. You can also store it in a .env file in your project root and the CLI will pick it up when running zendfi init.

The CLI detects whether your key is a test key (zfi_test_) or live key (zfi_live_). If you run a payment command with a live key, it will prompt for confirmation before proceeding.

Command Reference

Command	Description
zendfi init	Add ZendFi to an existing project
zendfi payment create	Create a test payment
zendfi payment status <id>	Check payment status
zendfi webhooks	Test webhooks locally via tunnel
zendfi keys list	List all API keys
zendfi keys create	Create a new API key
zendfi keys rotate <id>	Rotate an API key
zendfi intents create	Create a payment intent
zendfi intents list	List payment intents
zendfi intents get <id>	Get intent details
zendfi intents confirm <id>	Confirm a payment intent
zendfi intents cancel <id>	Cancel a payment intent
zendfi ppp check <country>	Get PPP factor for a country
zendfi ppp factors	List all PPP factors
zendfi ppp calculate	Calculate localized price

Command Groups

Init and Create

Project scaffolding and framework detection. Add ZendFi to existing projects or start from a template.

Payments

Create test payments, check status, and watch payment lifecycle in real time.

Webhooks

Local webhook testing with automatic tunnel setup through ngrok or Cloudflare.

API Keys

List, create, and rotate API keys directly from the terminal.

Payment Intents

Two-phase payment flow management with create, confirm, and cancel operations.

PPP Pricing

Purchasing Power Parity tools for international pricing optimization.

Global Options

Every command supports these flags:

Flag	Description
--help	Show help for a command
--version	Show CLI version

Environment Variables

Variable	Description	Default
ZENDFI_API_KEY	Your API key (required for most commands)	—
ZENDFI_API_URL	Custom API base URL	https://api.zendfi.tech/api/v1
DEBUG	Enable verbose output for troubleshooting	—

Quick Start

1. Install the CLI

   npm install -g @zendfi/cli
   
2. Set your API key

   export ZENDFI_API_KEY=zfi_test_your_key_here
   
3. Create a test payment

   zendfi payment create --amount 50
   

   The CLI creates the payment, copies the checkout URL to your clipboard, and optionally opens it in your browser.

4. Watch the payment

   zendfi payment status pay_test_abc123
   

   See rich, formatted payment details including status, timeline, transaction signature, and wallet addresses.

What’s Next

Init and Create

Set up new projects or add ZendFi to existing ones.

Test Payments

Create and monitor test payments from your terminal.