@uqpay/cli 1.2.0 → 2.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +37 -0
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -77,6 +77,43 @@ uqpay issuing card list
77
77
  uqpay payment intent list
78
78
  ```
79
79
 
80
+ Virtual Account applications are tracked separately from issued bank details:
81
+
82
+ ```bash
83
+ # Submit one application. Omit payment_method to evaluate LOCAL and SWIFT.
84
+ uqpay banking virtual-account create \
85
+ --idempotency-key va-application-001 \
86
+ -d country=SG -d currency=USD -d nickname=Collections
87
+
88
+ # List application summaries, then retrieve the complete current application.
89
+ uqpay banking virtual-account application list --page-num 1 --page-size 50
90
+ uqpay banking virtual-account application retrieve <application-id> -o json
91
+
92
+ # Existing command: list issued Virtual Account bank details, not applications.
93
+ uqpay banking virtual-account list --page-num 1 --page-size 50
94
+ ```
95
+
96
+ For connected accounts, add `--on-behalf-of <account-id>` to all three flows.
97
+ Reuse an idempotency key only for the same normalized Create request. Create
98
+ returns HTTP 200 application data; usable bank details arrive asynchronously.
99
+
100
+ For all mutating commands, the CLI keeps one `x-idempotency-key` across safe
101
+ HTTP retries such as token refresh and rate limiting. If a connection failure,
102
+ response-read failure, or HTTP 5xx response leaves the remote result uncertain,
103
+ the CLI does not automatically replay the write. JSON output reports
104
+ `error: "reconcile_required"` together with `method`, `path`, and
105
+ `idempotency_key`; inspect the corresponding resource before deciding whether
106
+ to submit another logical request.
107
+
108
+ Successful Gateway Create and Retrieve application data and each List summary
109
+ include required `account_id` and `direct_id` fields. `account_id` is the UUID of
110
+ the account that owns the application. `direct_id` is an ordinary string: `"0"`
111
+ for a main account and the main account ID for a connected account. The CLI does
112
+ not validate or transform either field; `-o json` preserves them as received.
113
+
114
+ The CLI does not parse or type webhook deliveries. Use a customer webhook
115
+ handler or an SDK verifier for that flow.
116
+
80
117
  Or inline without config file:
81
118
 
82
119
  ```bash
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@uqpay/cli",
3
- "version": "1.2.0",
3
+ "version": "2.0.1",
4
4
  "description": "UQPAY command-line tool for banking, issuing, and payment APIs",
5
5
  "bin": {
6
6
  "uqpay": "scripts/run.js"