@x-money / cli
xmoney，从终端获取X Money API。创建结帐会话、对关联帐户收费、发放退款和付款，以及读取API公开的任何内容。
每个命令都是一个薄薄的包装 @x-money /核心因此，两者不能在API提供的功能上产生分歧。
Node 24或更新版本。
npm install -g @x-money/cli
xmoney --help
或者不安装就运行它： npx @x-money/cli --help.
快速启动
xmoney login # prompts for a key, stores it on the default profile
xmoney whoami # shows which key and base url resolved, key masked
xmoney payments list --limit 10
凭证
键按顺序在三个地方查找： --api-key,然后 XMONEY_API_KEY，然后是磁盘上的配置文件。基url的解析方式相同 --base-url 和 XMONEY_API_BASE_URL，返回到配置文件，然后返回到SDK默认值。
配置文件将键分开，例如，测试模式键放在活动键旁边。 --profile 或者 XMONEY_PROFILE 选择一个，并命名默认值 default.
xmoney login --profile test # prompts for your xmsk_test_ key
xmoney payments list --profile test
配置文件位于 $XDG_CONFIG_HOME/xmoney/config.json，或者 ~/.config/xmoney/config.json 当它未设置时。它保存密钥，所以它是写的 0600 在一个 0700 目录，并将现有文件收紧到 0600 每次写。
命令
| 资源 | 行动 |
|---|---|
checkouts | create， get |
exchanges | create， get |
accounts | get， list， revoke |
customers | get， list |
payments | create， get， list， capture， release-authorization， update-authorization |
refunds | create， get， list |
payouts | create， get， list， reverse |
settlements | list， get， file |
+ login 和 whoami. xmoney --help 打印完整的标志引用，和 --help 适用于任何命令。
根据方法检查该表 @x-money/core 在两个方向上都是公开的，所以如果在同一个发行版中没有命令发布，资源就无法到达SDK。
创造新事物
每一个 create 接受输入的标志，列在下面 xmoney --help。任何他们没有覆盖的都可以通过 --data 作为原始JSON，和 --metadata k=v 重复。
xmoney refunds create --payment <payment-id> --amount 500 --reference refund-order-8471
xmoney payouts create --data '{"account_id":"xmac_...","amount":2500}'
金额是以货币最小单位表示的整数，所以 49999 是499.99美元。
每个POST都携带一个生成的等幂键。通过 --idempotency-key 使跨调用的重试安全，当命令由订单id驱动时，这是您想要的。
有了测试钥匙， --test-outcome 发送 Xm-Test-Outcome 头，例如强制拒绝、过期或授权错误 --test-outcome INSUFFICIENT_FUNDS.
分页
列表返回一个页面。 --all 跟随游标到末尾并返回累积集，因此它是每个页面的请求，对于大型帐户来说值得考虑。
xmoney payouts list --limit 100 --all
输出和退出代码
结果是标准输出上的JSON，没有别的，所以 | jq 作品。其他所有内容，包括提示和错误，都将进入stderr。
--verbose 为每个请求添加一个标准错误行，包含其方法、路径、状态和 x-request-id，因此，一个调用成功了，但返回了一些令人惊讶的结果，仍然会留下一个id来引用。
| 退出 | 意义 |
|---|---|
0 | 成功。 |
1 | API返回了一个错误。错误对象，带有其 code， status, request_id，将被打印为JSON。 |
2 | 请求没有得到响应：网络故障、超时或中止。 |
64 | 命令行或凭证错误：缺少标志，或密钥不是密钥。什么也没发。 |
SDK可以引发的每个错误都映射到其中一个。堆栈跟踪意味着CLI本身存在错误。
文档
指南、API参考和webhook目录在 xmoney.mintlify.site /文档.
支持
报告错误并提出问题 X帮助中心。安全问题也是如此；请不要公开发布。
许可证
麻省理工学院。全文在包中作为 LICENSE.