Định dạng output của SePay CLI

Chọn output dạng bảng, JSON hoặc YAML cho lệnh SePay CLI, biết dòng nào ra stdout, dòng nào ra stderr, và cách CLI co bảng theo độ rộng terminal.

||

Lệnh SePay CLI in kết quả dạng bảng khi bạn đọc bằng mắt. Khi cần đưa kết quả vào script hoặc jq, thêm --json (hoặc -o json), hay -o yaml cho YAML.

Chọn định dạng

FlagKết quả
Không có (-o table)Bảng, mỗi dòng một bản ghi. Lệnh xem một bản ghi như transaction get, bank-account get in bảng hai cột FIELD, VALUE
--json, -o jsonJSON. Lệnh liệt kê trả một mảng, lệnh xem trả một object
-o yamlYAML, cùng cấu trúc với JSON

Xem một tài khoản ngân hàng dạng JSON:

$ sepay bank-account get 832529c1-xxxx-xxxx-xxxx-fa163e2f7c98 --json{"id": "832529c1-xxxx-xxxx-xxxx-fa163e2f7c98","account_holder_name": "NGUYEN VAN A","account_number": "0000000001","accumulated": 0,"last_transaction": null,"label": "Cua hang Quan 1","account_type": "individual","active": 1,"created_at": "2026-10-17 15:00:19","bank_short_name": "ACB","bank_full_name": "Ngân hàng TMCP Á Châu","bank_bin": "970416","bank_code": "ACB"}

Tên trường trong JSON và YAML giống tên trường của SePay API, khác tiêu đề cột của bảng. JSON giữ nguyên &, <, > trong URL và nội dung, không đổi thành \u0026.

--json và -o yaml cũng dùng được với sepay --version và sepay version:

$ sepay --version --json{"arch": "amd64","commit": "xxxxxxx","date": "YYYY-MM-DD","go_version": "go1.x.x","os": "linux","version": "x.x.x"}

stdout và stderr

stdout chỉ chứa dữ liệu, nên pipe thẳng vào jq hoặc ghi ra tệp được. Các dòng còn lại ra stderr:

  • Dòng env: sandbox cho biết môi trường đang dùng. Dòng này không có khi dùng --json, -o yaml hoặc -q.
  • Dòng phân trang của lệnh liệt kê, ví dụ page 1/24 · 2 of 48, kèm gợi ý dùng --page, --per-page khi còn trang sau.
  • Lỗi và cảnh báo. Với --json, lỗi cũng là JSON, xem định dạng lỗi.

Cách script đọc dữ liệu, lỗi và exit code có ở Dùng SePay CLI trong script.

Bảng trong terminal hẹp

Khi terminal hẹp hơn bảng, CLI thu hẹp khoảng cách giữa các cột và cắt bớt cột chữ tự do như nội dung chuyển khoản, đánh dấu bằng …. Các cột ID, số tiền và mã giữ nguyên:

$ sepay transaction list --per-page 2env: sandboxID                                    DATE                 AMOUNT    CONTENT  CODE    BANK    WH07ad3dc9-xxxx-xxxx-xxxx-0afffe87053b  2026-10-31 11:24:40  +50.000   Giao d…  DH1709  ACB     fail3e75c65e-xxxx-xxxx-xxxx-a6006ab65aca  2026-10-20 00:33:49  +100.000  Giao d…  -       MBBank  fail

Cắt xong vẫn không vừa thì bảng xuống dòng. Khi output được pipe sang lệnh khác hoặc ghi ra tệp, bảng giữ đủ chữ. Cần dữ liệu đầy đủ trong script thì dùng --json.

Chỉ lấy một số trường

transaction list nhận --fields để API chỉ trả các trường bạn cần. Các trường khác vẫn có trong JSON nhưng để trống hoặc null; trong bảng, chúng hiện (hidden):

$ sepay transaction list --per-page 1 --fields id,amount_in,code --json[{  "id": "07ad3dc9-xxxx-xxxx-xxxx-0afffe87053b",  "transaction_date": "",  "account_number": "",  "va": null,  "transfer_type": "",  "amount_in": 50000,  "amount_out": null,  "accumulated": null,  "transaction_content": null,  "reference_number": null,  "code": "DH1709",  "bank_brand_name": "",  "bank_account_id": "",  "va_id": null,  "webhook_success": null}]

Màu

CLI chỉ tô màu khi in ra terminal. Tắt màu cho một lệnh bằng --no-color, hoặc cho mọi lệnh bằng biến môi trường NO_COLOR=1 (NO_COLOR=0 vẫn giữ màu), xem Biến môi trường.