CLI

The UQPAY CLI provides command-line access to Account Center, Global Account, Global Acquiring, Card Issuance, Supporting Services, and sandbox simulation. It supports more than 100 commands across these domains.

GitHub

Source code and issues

The CLI is open source (MIT) and works on macOS, Linux, and Windows (amd64 and arm64). Version 1.2.0 is its first release in the coordinated client release line.

Installation

npm (recommended)

The npm installer requires Node.js 22 or later. The installed uqpay binary does not require Node.js at runtime.

npm install -g @uqpay/cli

You can also download release archives and checksums from GitHub Releases.

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

Before you begin, create a sandbox account and create API keys. 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:

Variable	Description
`UQPAY_CLIENT_ID`	Client ID
`UQPAY_API_KEY`	API key
`UQPAY_ENV`	`sandbox` or `production`
`UQPAY_OUTPUT`	Default 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

Retries

The CLI automatically retries rate limits (429) and server errors (5xx) up to two times. It honors the server’s Retry-After header when present.

AI agent skills

The CLI ships with six structured skills in the skills/ directory, enabling AI agents to operate UQPAY APIs without additional configuration:

Skill	Scope
`uqpay-shared`	Configuration, authentication, global flags
`uqpay-banking`	Global Account operations
`uqpay-issuing`	Card and cardholder management
`uqpay-payment`	Payment processing
`uqpay-connect`	Connected account management
`uqpay-simulate`	Sandbox simulation

Install skills alongside the CLI:

npx skills add uqpay/uqpay-cli -y -g

MCP

SDKs

CLI

GitHub

Installation

npm (recommended)

Build from source

Shell completion

Configuration

Quick start

Output formats

Sub-account operations

Debugging

Retries

AI agent skills

GitHub

​Installation

​npm (recommended)

​Build from source

​Shell completion

​Configuration

​Quick start

​Output formats

​Sub-account operations

​Debugging

​Retries

​AI agent skills

Installation

npm (recommended)

Build from source

Shell completion

Configuration

Quick start

Output formats

Sub-account operations

Debugging

Retries

AI agent skills