Skip to main content
The UQPAY CLI provides command-line access to Global Account, Card Issuance, and Payment APIs. It supports 100+ commands across all business domains.

GitHub

Source code and issues
The CLI is open source (MIT) and works on macOS, Linux, and Windows (amd64 and arm64).

​
Installation

npm install -g @uqpay/cli

​
Build from source

Requires Go 1.21 or higher: 
git clone https://github.com/uqpay/uqpay-cli.git
cd uqpay-cli
make install

​
Shell completion

uqpay setup-completion
source ~/.zshrc  # or ~/.bashrc

​
Configuration

Run these once to set your credentials: 
uqpay config set client-id YOUR_CLIENT_ID
uqpay config set api-key YOUR_API_KEY
uqpay config set env sandbox
You can also pass credentials inline per command: 
uqpay --env sandbox --client-id ID --api-key KEY banking balance list
Or use environment variables:
VariableDescription
UQPAY_CLIENT_IDClient ID
UQPAY_API_KEYAPI key
UQPAY_ENVsandbox or production
UQPAY_OUTPUTDefault output format

​
Quick start

# List balances
uqpay banking balance list

# List cards
uqpay issuing card list

# List payment intents
uqpay payment intent list

​
Output formats

uqpay banking balance list           # table (default)
uqpay banking balance list -o json   # JSON
uqpay banking balance list -o yaml   # YAML

​
Sub-account operations

Execute commands on behalf of a connected account: 
uqpay --on-behalf-of <account-id> banking balance list

​
Debugging

Use the --debug flag to display full HTTP request and response details: 
uqpay --debug banking balance list

​
AI agent skills

The CLI ships with six structured skills in the skills/ directory, enabling AI agents to operate UQPAY APIs without additional configuration:
SkillScope
uqpay-sharedConfiguration, authentication, global flags
uqpay-bankingGlobal Account operations
uqpay-issuingCard and cardholder management
uqpay-paymentPayment processing
uqpay-connectConnected account management
uqpay-simulateSandbox simulation
Install skills alongside the CLI: 
npx skills add uqpay/uqpay-cli -y -g