Command syntax

Command structure

All commands follow the pattern:

uqpay <domain> <resource> <action> [flags]

Run uqpay --help to browse the complete command tree, or append --help to any domain, resource, or action for its current fields and flags.

Domains

Domain	Resources
`banking`	Balances, transfers, deposits, payouts, beneficiaries, conversions, virtual accounts
`issuing`	Cards, cardholders, transactions, spending controls, reports
`payment`	Intents, attempts, refunds, settlements, bank accounts
`connect`	Connected accounts, sub-account onboarding, KYC uploads
`simulate`	Sandbox testing — deposits, authorizations, reversals
`file`	Document uploads and retrieval links

Quick aliases

Common resources have top-level shortcuts so you can skip the domain name:

Alias	Equivalent
`uqpay beneficiary list`	`uqpay banking beneficiary list`
`uqpay card list`	`uqpay issuing card list`
`uqpay payout list`	`uqpay banking payout list`

Read operations

Use flags to pass query parameters:

uqpay banking beneficiary list --page-num 2 --page-size 20

Write operations

Use -d key=value to pass request body fields. Dot notation creates nested objects. This fragment demonstrates the syntax; run uqpay beneficiary create --help for the complete set of required fields.

uqpay banking beneficiary create \
  -d entity_type=INDIVIDUAL \
  -d first_name=John \
  -d bank_details.swift_code=DBSSSGSG

Values default to strings. Commands convert known numeric fields automatically. For other fields that require a JSON number, use the num: prefix, such as -d inherit=num:-1. Use str: to force a value to remain a string.

File encoding

Base64 encoding

Prefix the file path with @ to base64-encode a local file:

-d identity.front_file=@./passport.jpg

Data URI format

For Connect document uploads, use @+ to encode as a data URI:

-d "documents[0].front=@+./cert.png"

MCP

CLI

SDKs

Command structure

Domains

Quick aliases

Read operations

Write operations

File encoding

Base64 encoding

Data URI format

​Command structure

​Domains

​Quick aliases

​Read operations

​Write operations

​File encoding

​Base64 encoding

​Data URI format

Command structure

Domains

Quick aliases

Read operations

Write operations

File encoding

Base64 encoding

Data URI format