Tra cứu cú pháp và flag riêng của từng lệnh SePay CLI, lệnh chạy trên môi trường nào và lệnh nào hỏi xác nhận. Flag dùng chung cho mọi lệnh như --env, --json, --yes có ở Flag dùng chung. Trên production, lệnh xem dữ liệu cần scope read, lệnh sửa dữ liệu cần scope ghi ở mục của lệnh đó.
Mỗi lệnh in hướng dẫn đầy đủ bằng sepay <lệnh> --help.
Đăng nhập và phiên
Hướng dẫn kèm ví dụ: Xác thực.
auth login
Đăng nhập SePay.
$ sepay auth login| Flag | Kiểu | Mô tả |
|---|---|---|
--insecure-storage | bool | Lưu token trong tệp 0600 thay vì keychain |
--scopes | string | Scope cần xin, ngăn cách bằng dấu phẩy; mặc định read,webhook:write,bank-account:write,paycode:write,pg:read,einvoice:read |
--with-token | bool | Đọc refresh token từ stdin, không mở trình duyệt |
auth logout
Đăng xuất và xóa thông tin đăng nhập đã lưu.
$ sepay auth logout| Flag | Kiểu | Mô tả |
|---|---|---|
--all | bool | Đăng xuất mọi profile đã lưu |
--local | bool | Xóa thông tin đăng nhập trên máy mà không thu hồi phiên trên SePay |
auth refresh
Gia hạn token và đổi scope.
$ sepay auth refresh| Flag | Kiểu | Mô tả |
|---|---|---|
--remove-scopes | string | Scope cần bỏ, ngăn cách bằng dấu phẩy |
--reset-scopes | bool | Bỏ qua scope hiện tại, chỉ giữ các scope trong --scopes |
--scopes | string | Scope cần có, ngăn cách bằng dấu phẩy; được thêm vào tập hiện tại, trừ khi có --reset-scopes |
auth revoke
Thu hồi phiên đăng nhập trên SePay.
$ sepay auth revoke [profile]| Flag | Kiểu | Mô tả |
|---|---|---|
--all | bool | Thu hồi mọi phiên của tài khoản |
--token | string | Thu hồi một phiên theo id (xem sepay auth sessions) |
auth sessions
Liệt kê các phiên đăng nhập của tài khoản.
$ sepay auth sessionsauth status
Xem các profile đã lưu và profile mặc định.
$ sepay auth statusstls| Flag | Kiểu | Mô tả |
|---|---|---|
--active | bool | Chỉ hiện profile mặc định |
auth switch
Đổi profile mặc định.
$ sepay auth switch <profile>swauth token
In refresh token đang lưu.
$ sepay auth tokenlogin
Đăng nhập SePay.
$ sepay login| Flag | Kiểu | Mô tả |
|---|---|---|
--insecure-storage | bool | Lưu token trong tệp 0600 thay vì keychain |
--scopes | string | Scope cần xin, ngăn cách bằng dấu phẩy; mặc định read,webhook:write,bank-account:write,paycode:write,pg:read,einvoice:read |
--with-token | bool | Đọc refresh token từ stdin, không mở trình duyệt |
logout
Đăng xuất và xóa thông tin đăng nhập đã lưu.
$ sepay logout| Flag | Kiểu | Mô tả |
|---|---|---|
--all | bool | Đăng xuất mọi profile đã lưu |
--local | bool | Xóa thông tin đăng nhập trên máy mà không thu hồi phiên trên SePay |
Cấu hình
Viết tắt của nhóm: cfg. Hướng dẫn kèm ví dụ: Môi trường và cấu hình.
config get
In một thiết lập, hoặc mọi thiết lập đã đặt.
$ sepay config get [key]listlsconfig set
Đặt một thiết lập và lưu vào config.yml.
$ sepay config set <key> <value>Webhook
Viết tắt của nhóm: wh. Hướng dẫn kèm ví dụ: Webhook.
webhook create
Tạo webhook.
$ sepay webhook createwebhook:writenew| Flag | Kiểu | Mô tả |
|---|---|---|
--auth-type | string | Kiểu xác thực: none|apikey|hmac|oauth2 |
--bank-account | string[] | Xid tài khoản ngân hàng, lặp flag để chọn nhiều (bắt buộc với --bank-mode single|multi) |
--bank-config | string[] | Tài khoản báo những gì: xid=on|off:all|list|none, tức có báo số tài khoản chính không và báo VA nào; lặp flag cho nhiều tài khoản |
--bank-mode | string | Phạm vi tài khoản: single|multi|all (bắt buộc khi tạo mà CLI không hỏi được) |
--content-type | string | Kiểu nội dung của request: json|form|multipart |
--dry-run | bool | Chạy thử: in phần sẽ thay đổi mà không gửi lệnh ghi (các lệnh đọc đi kèm vẫn chạy) |
--event-type | string | Loại sự kiện: all|in|out; mặc định all |
--listen-only | bool | Không có URL nhận; xem sự kiện bằng sepay webhook listen (chỉ sandbox) |
--name | string | Tên webhook |
--oauth2-client-id | string | Client ID OAuth2 (với --auth-type oauth2) |
--oauth2-client-secret | string | Client secret OAuth2 (với --auth-type oauth2), hoặc - để đọc từ stdin |
--oauth2-token-url | string | URL lấy access token OAuth2 (với --auth-type oauth2) |
--only-va | bool | Chỉ giao dịch qua VA |
--prefix-filter | string[] | Chỉ chuyển giao dịch có các tiền tố mã thanh toán này |
--secret | string | Secret dùng chung cho xác thực apikey, hmac; - để đọc từ stdin |
--skip-if-no-code | bool | Bỏ qua giao dịch không có mã thanh toán |
--url | string | URL nhận webhook (bắt buộc, trừ khi có --listen-only) |
--va-xid | string[] | Xid VA áp dụng; lặp flag để chọn nhiều VA |
--verify-payment | bool | Chỉ chuyển giao dịch đã xác thực |
webhook delete
Xóa webhook.
$ sepay webhook delete <webhook-xid>webhook:writermdel| Flag | Kiểu | Mô tả |
|---|---|---|
--dry-run | bool | Chạy thử: in phần sẽ thay đổi mà không gửi lệnh ghi (các lệnh đọc đi kèm vẫn chạy) |
webhook get
Xem một webhook.
$ sepay webhook get <webhook-xid>webhook list
Liệt kê webhook.
$ sepay webhook listls| Flag | Kiểu | Mô tả |
|---|---|---|
--active | string | Lọc theo trạng thái: 0|1 |
--page | int | Số trang |
--per-page | int | Số dòng mỗi trang (tối đa 100) |
webhook listen
Chuyển webhook tới handler trên máy (chỉ sandbox)
$ sepay webhook listentail| Flag | Kiểu | Mô tả |
|---|---|---|
--events | string[] | Chỉ chuyển các loại sự kiện này, ngăn cách bằng dấu phẩy: payment_in, payment_out |
--forward | string | Địa chỉ handler trên máy, ví dụ localhost:3000 (bỏ trống thì CLI hỏi) |
--forward-credentials | bool | Chuyển header xác thực (Authorization, X-Secret-Key) tới handler không phải loopback; mặc định không chuyển |
--forward-retries | int | Số lần gửi lại khi chuyển tới handler thất bại, theo lịch của SePay (0 là không gửi lại); mặc định 7 |
--headers | bool | In header của request chuyển tiếp |
--print | bool | In thêm toàn bộ payload của sự kiện |
--reconnect-max | int | Số lần kết nối lại tối đa (0 là không giới hạn) |
--skip-tls-verify | bool | Bỏ kiểm tra TLS cho handler https trên máy (khi đó không chuyển header xác thực) |
--webhook | string | Chỉ chuyển lần gửi của webhook này (xid, xem sepay webhook list) |
webhook logs
Liệt kê lịch sử gửi webhook.
$ sepay webhook logs [webhook-xid]log| Flag | Kiểu | Mô tả |
|---|---|---|
--page | int | Số trang |
--per-page | int | Số dòng mỗi trang (tối đa 100) |
--since | string | Chỉ log từ thời điểm này: khoảng thời gian (24h), ngày hoặc ngày giờ |
--status | string | Lọc theo kết quả gửi: success|failed|listen|skipped |
--transaction | string | Lọc theo mã giao dịch |
--until | string | Chỉ log đến ngày hoặc ngày giờ này (chỉ ghi ngày thì tính hết ngày đó) |
--webhook | string | Lọc theo xid webhook |
webhook replay
Gửi lại một lần gửi webhook trong lịch sử.
$ sepay webhook replay [transaction-id]webhook:write| Flag | Kiểu | Mô tả |
|---|---|---|
--dry-run | bool | Chạy thử: in phần sẽ thay đổi mà không gửi lệnh ghi (các lệnh đọc đi kèm vẫn chạy) |
--force | bool | Gửi lại cả lần gửi handler đã nhận thành công; trên production phải gõ lại mã giao dịch để xác nhận |
--transaction | string | Mã giao dịch của lần gửi (giống đối số) |
--webhook | string | Xid webhook của lần gửi |
webhook test
Gửi một sự kiện và kiểm tra handler trả lời (chỉ sandbox)
$ sepay webhook test| Flag | Kiểu | Mô tả |
|---|---|---|
--amount | int64 | Số tiền VND (bắt buộc) |
--bank-account | string | Xid tài khoản ngân hàng sandbox nhận sự kiện |
--event | string | Loại sự kiện cần gửi: payment_in, payment_out, va_credit; mặc định payment_in |
--expect-status | int | HTTP status mong đợi (0 là mọi mã 2xx) |
--forward | string | Địa chỉ handler trên máy, ví dụ localhost:3000 (bắt buộc) |
--forward-credentials | bool | Chuyển header xác thực (Authorization, X-Secret-Key) tới handler không phải loopback; mặc định không chuyển |
--timeout | duration | Thời gian chờ handler; mặc định 10s |
--va | string | Số VA (với va_credit) |
--webhook | string | Chỉ xét lần gửi của webhook này (xem sepay webhook list) |
webhook update
Sửa webhook (chỉ đổi các flag bạn truyền)
$ sepay webhook update <webhook-xid>webhook:writeedit| Flag | Kiểu | Mô tả |
|---|---|---|
--auth-type | string | Kiểu xác thực: none|apikey|hmac|oauth2 |
--bank-account | string[] | Xid tài khoản ngân hàng, lặp flag để chọn nhiều (bắt buộc với --bank-mode single|multi) |
--bank-config | string[] | Tài khoản báo những gì: xid=on|off:all|list|none, tức có báo số tài khoản chính không và báo VA nào; lặp flag cho nhiều tài khoản |
--bank-mode | string | Phạm vi tài khoản: single|multi|all (bắt buộc khi tạo mà CLI không hỏi được) |
--content-type | string | Kiểu nội dung của request: json|form|multipart |
--dry-run | bool | Chạy thử: in phần sẽ thay đổi mà không gửi lệnh ghi (các lệnh đọc đi kèm vẫn chạy) |
--event-type | string | Loại sự kiện: all|in|out; mặc định all |
--listen-only | bool | Không có URL nhận; xem sự kiện bằng sepay webhook listen (chỉ sandbox) |
--name | string | Tên webhook |
--oauth2-client-id | string | Client ID OAuth2 (với --auth-type oauth2) |
--oauth2-client-secret | string | Client secret OAuth2 (với --auth-type oauth2), hoặc - để đọc từ stdin |
--oauth2-token-url | string | URL lấy access token OAuth2 (với --auth-type oauth2) |
--only-va | bool | Chỉ giao dịch qua VA |
--prefix-filter | string[] | Chỉ chuyển giao dịch có các tiền tố mã thanh toán này |
--secret | string | Secret dùng chung cho xác thực apikey, hmac; - để đọc từ stdin |
--skip-if-no-code | bool | Bỏ qua giao dịch không có mã thanh toán |
--url | string | URL nhận webhook (bắt buộc, trừ khi có --listen-only) |
--va-xid | string[] | Xid VA áp dụng; lặp flag để chọn nhiều VA |
--verify-payment | bool | Chỉ chuyển giao dịch đã xác thực |
Giao dịch
Viết tắt của nhóm: tx, txn. Hướng dẫn kèm ví dụ: Giao dịch.
transaction get
Xem một giao dịch.
$ sepay transaction get <transaction-xid>transaction list
Liệt kê giao dịch.
$ sepay transaction listls| Flag | Kiểu | Mô tả |
|---|---|---|
--amount-in-max | string | Tiền vào tối đa |
--amount-in-min | string | Tiền vào tối thiểu |
--amount-in-sort | string | Sắp xếp theo tiền vào: asc|desc |
--amount-out-max | string | Tiền ra tối đa |
--amount-out-min | string | Tiền ra tối thiểu |
--amount-out-sort | string | Sắp xếp theo tiền ra: asc|desc |
--bank | string | Lọc theo ngân hàng, ví dụ ACB, BIDV |
--bank-account | string | Lọc theo xid tài khoản ngân hàng |
--fields | string | Các trường cần trả về, ngăn cách bằng dấu phẩy |
--from | string | Ngày bắt đầu, tính cả ngày này (YYYY-MM-DD) |
--page | int | Số trang |
--per-page | int | Số dòng mỗi trang (tối đa 100) |
--reference-number | string | Lọc theo mã tham chiếu (khớp chính xác) |
--search | string | Tìm theo mã tham chiếu, nội dung hoặc mã thanh toán |
--since-id | string | Trả về các giao dịch sau xid này |
--to | string | Ngày kết thúc, tính cả ngày này (YYYY-MM-DD) |
--transaction-content | string | Lọc theo nội dung |
--transaction-date-sort | string | Sắp xếp theo ngày: asc|desc |
--transfer-type | string | Lọc theo chiều tiền: in|out |
--va-xid | string | Lọc theo xid VA |
--webhook-success | string | Lọc theo trạng thái gửi webhook: 0|1 |
Tài khoản ngân hàng
Viết tắt của nhóm: ba. Hướng dẫn kèm ví dụ: Tài khoản ngân hàng.
bank-account create
Tạo tài khoản ngân hàng (chỉ sandbox)
$ sepay bank-account createnew| Flag | Kiểu | Mô tả |
|---|---|---|
--account-type | string | individual|business_household|enterprise (bắt buộc) |
--bank | string | Mã ngân hàng, ví dụ ACB (bắt buộc) |
--connection | string | sms|api; sms chỉ dùng được với gói còn hỗ trợ SMS; mặc định api |
--holder-name | string | Tên chủ tài khoản; tự tạo nếu bỏ trống |
--label | string | Nhãn hiển thị |
bank-account delete
Xóa tài khoản ngân hàng (chỉ sandbox)
$ sepay bank-account delete <bank-account-xid>rmdelbank-account get
Xem một tài khoản ngân hàng.
$ sepay bank-account get <bank-account-xid>bank-account list
Liệt kê tài khoản ngân hàng.
$ sepay bank-account listls| Flag | Kiểu | Mô tả |
|---|---|---|
--accumulated-max | string | Số dư lũy kế tối đa |
--accumulated-min | string | Số dư lũy kế tối thiểu |
--accumulated-sort | string | Sắp xếp theo số dư: asc|desc |
--active | string | Lọc theo trạng thái: 0|1|true|false |
--bank | string | Lọc theo ngân hàng, ví dụ ACB, BIDV |
--created-at-sort | string | Sắp xếp theo ngày tạo: asc|desc |
--last-transaction-from | string | Giao dịch gần nhất từ ngày này trở đi (YYYY-MM-DD) |
--last-transaction-sort | string | Sắp xếp theo giao dịch gần nhất: asc|desc |
--last-transaction-to | string | Giao dịch gần nhất tới hết ngày này (YYYY-MM-DD) |
--page | int | Số trang |
--per-page | int | Số dòng mỗi trang (tối đa 100) |
--search | string | Tìm theo tên chủ tài khoản, nhãn hoặc số tài khoản |
bank-account update
Đổi nhãn tài khoản ngân hàng.
$ sepay bank-account update <bank-account-xid>bank-account:writeedit| Flag | Kiểu | Mô tả |
|---|---|---|
--dry-run | bool | Chạy thử: in phần sẽ thay đổi mà không gửi lệnh ghi (các lệnh đọc đi kèm vẫn chạy) |
--label | string | Nhãn hiển thị |
Tài khoản ảo (VA)
Hướng dẫn kèm ví dụ: Mã thanh toán.
va get
Xem một VA.
$ sepay va get <va-xid>| Flag | Kiểu | Mô tả |
|---|---|---|
--bank-account | string | Xid tài khoản ngân hàng chứa VA |
va issue
Cấp VA cho một tài khoản ngân hàng (chỉ sandbox)
$ sepay va issue| Flag | Kiểu | Mô tả |
|---|---|---|
--bank-account | string | Xid tài khoản ngân hàng sẽ chứa VA (bắt buộc) |
--label | string | Nhãn hiển thị |
--terminal-name | string | Tên terminal (Vietcombank OneQR, tự tạo terminal) |
--tid | string | Mã terminal (Vietcombank OneQR) |
va list
Liệt kê VA của một tài khoản ngân hàng.
$ sepay va listls| Flag | Kiểu | Mô tả |
|---|---|---|
--active | string | Lọc theo trạng thái: 0|1|true|false |
--bank-account | string | Xid tài khoản ngân hàng chứa VA |
--created-at-sort | string | Sắp xếp theo ngày tạo: asc|desc |
--official | string | Lọc VA chính thức: 0|1 |
--page | int | Số trang |
--per-page | int | Số dòng mỗi trang (tối đa 100) |
--search | string | Tìm theo số VA hoặc nhãn |
--static | string | Lọc VA cố định: 0|1 |
va revoke
Thu hồi VA (chỉ sandbox)
$ sepay va revoke <va-xid|va-number>| Flag | Kiểu | Mô tả |
|---|---|---|
--bank-account | string | Xid tài khoản ngân hàng chứa VA (bắt buộc) |
Mã thanh toán
Viết tắt của nhóm: pc. Hướng dẫn kèm ví dụ: Mã thanh toán.
paycode create
Thêm một cấu trúc mã thanh toán.
$ sepay paycode create [prefix]paycode:write| Flag | Kiểu | Mô tả |
|---|---|---|
--active | bool | Bật (--active) hoặc tắt (--active=false) cấu trúc (bắt buộc) |
--character-type | string | NumberOnly (chỉ số) hoặc NumberAndLetter (số và chữ) (bắt buộc) |
--dry-run | bool | Chạy thử: in phần sẽ thay đổi mà không gửi lệnh ghi (các lệnh đọc đi kèm vẫn chạy) |
--prefix | string | Tiền tố mã thanh toán (2 đến 5 chữ cái), giống đối số; dùng khi tiền tố trùng từ khóa on|off|yes|no|true|false |
--suffix-from | int | Độ dài hậu tố ngắn nhất, từ 1 đến 30; bằng --suffix-to khi muốn độ dài cố định (bắt buộc) |
--suffix-to | int | Độ dài hậu tố dài nhất, từ 1 đến 30, không nhỏ hơn --suffix-from (bắt buộc) |
paycode list
Xem các cấu trúc mã thanh toán và nhận diện mã đang bật hay tắt.
$ sepay paycode listlspaycode update
Sửa cấu trúc mã thanh toán hoặc bật, tắt nhận diện mã.
$ sepay paycode update [prefix]paycode:writeedit| Flag | Kiểu | Mô tả |
|---|---|---|
--active | bool | Bật (--active) hoặc tắt (--active=false) cấu trúc này; mặc định true |
--character-type | string | NumberOnly (chỉ số) hoặc NumberAndLetter (số và chữ) |
--disable | bool | Tắt nhận diện mã thanh toán |
--dry-run | bool | Chạy thử: in phần sẽ thay đổi mà không gửi lệnh ghi (các lệnh đọc đi kèm vẫn chạy) |
--enable | bool | Bật nhận diện mã thanh toán |
--prefix | string | Tiền tố mã thanh toán (2 đến 5 chữ cái), giống đối số; dùng khi tiền tố trùng từ khóa on|off|yes|no|true|false |
--structure | string | Tiền tố của cấu trúc cần sửa (mặc định: hỏi trong terminal, chạy trong script thì sửa cấu trúc đang bật đầu tiên) |
--suffix-from | int | Độ dài hậu tố ngắn nhất, từ 1 đến 30; bỏ trống thì giữ giá trị đang lưu, bằng --suffix-to khi muốn độ dài cố định |
--suffix-to | int | Độ dài hậu tố dài nhất, từ 1 đến 30, không nhỏ hơn --suffix-from; bỏ trống thì giữ giá trị đang lưu |
Sandbox
Viết tắt của nhóm: sbx. Hướng dẫn kèm ví dụ: Sandbox.
sandbox init
Dựng sẵn sandbox (tài khoản, VA, webhook, dữ liệu mẫu)
$ sepay sandbox init| Flag | Kiểu | Mô tả |
|---|---|---|
--bank | string | Mã ngân hàng của tài khoản dựng sẵn; mặc định ACB nếu sandbox có ACB, không thì lấy ngân hàng đầu tiên trong danh sách |
--seed | int | Tạo số giao dịch mẫu này (tối đa 100) |
--with-va | bool | Cấp thêm một VA |
--with-webhook | string | Tạo thêm webhook gửi tới URL này |
--with-webhook-listen | bool | Tạo thêm webhook không có URL, nhận qua sepay webhook listen |
sandbox reset
Xóa dữ liệu sandbox của công ty (webhook và tài khoản ngân hàng)
$ sepay sandbox resetsandbox seed
Thêm giao dịch mẫu vào sandbox.
$ sepay sandbox seed| Flag | Kiểu | Mô tả |
|---|---|---|
--bank-account | string | Xid tài khoản ngân hàng nhận giao dịch mẫu (bắt buộc) |
--count | int | Số giao dịch cần tạo, từ 1 đến 100 (mặc định 5) |
sandbox simulate
Giả lập một giao dịch trên sandbox.
$ sepay sandbox simulate [event]| Flag | Kiểu | Mô tả |
|---|---|---|
--amount | int64 | Số tiền VND (bắt buộc) |
--bank-account | string | Xid tài khoản ngân hàng (bắt buộc) |
--code | string | Mã thanh toán (tối đa 10 ký tự) |
--event | string | Loại sự kiện (hoặc truyền làm đối số): payment_in, payment_out, va_credit |
--override | string[] | Ghi đè trường trong payload dạng key=val; lặp flag để ghi đè nhiều trường (chỉ hỗ trợ content) |
--va | string | Số VA (bắt buộc với va_credit) |
API Token sandbox
Viết tắt của nhóm: ak. Hướng dẫn kèm ví dụ: API Token.
apikey create
Tạo API key (chỉ sandbox)
$ sepay apikey createnew| Flag | Kiểu | Mô tả |
|---|---|---|
--active | bool | Tạo key ở trạng thái bật; mặc định true |
--name | string | Tên key (bắt buộc) |
apikey delete
Xóa API key (chỉ sandbox)
$ sepay apikey delete <api-key-xid>rmdelapikey get
Xem một API key (chỉ sandbox)
$ sepay apikey get <api-key-xid>apikey list
Liệt kê API key (chỉ sandbox)
$ sepay apikey listlsapikey update
Đổi tên hoặc trạng thái API key (chỉ sandbox)
$ sepay apikey update <api-key-xid>edit| Flag | Kiểu | Mô tả |
|---|---|---|
--active | bool | Bật (--active) hoặc tắt (--active=false) key; mặc định true |
--name | string | Tên key mới |
Cổng thanh toán
Hướng dẫn kèm ví dụ: Cổng thanh toán.
pg auth
Xem hoặc lấy lại credential cổng thanh toán sandbox.
$ sepay pg auth| Flag | Kiểu | Mô tả |
|---|---|---|
--insecure-storage | bool | Lưu credential trong tệp 0600 thay vì keychain |
--refresh | bool | Lấy bộ credential mới |
pg checkout init
Tạo đơn và trả về URL trang thanh toán.
$ sepay pg checkout init| Flag | Kiểu | Mô tả |
|---|---|---|
--amount | string | Số tiền đơn hàng (bắt buộc) |
--cancel-url | string | URL chuyển về khi khách hủy |
--currency | string | Tiền tệ; mặc định VND |
--customer | string | Mã khách hàng |
--description | string | Mô tả đơn hàng (bắt buộc) |
--error-url | string | URL chuyển về khi lỗi |
--invoice | string | Mã đơn hàng: chữ, số, - và _ (bắt buộc với PURCHASE) |
--no-open | bool | In URL, không mở trình duyệt |
--operation | string | PURCHASE|VERIFY; mặc định PURCHASE |
--payment-method | string | BANK_TRANSFER|CARD|NAPAS_BANK_TRANSFER (không bắt buộc) |
--success-url | string | URL chuyển về khi thanh toán thành công |
pg ipn get
Xem địa chỉ nhận IPN cổng thanh toán.
$ sepay pg ipn getshowpg ipn listen
Chuyển IPN cổng thanh toán tới handler trên máy.
$ sepay pg ipn listentail| Flag | Kiểu | Mô tả |
|---|---|---|
--events | string[] | Chỉ chuyển các loại sự kiện này, ngăn cách bằng dấu phẩy: ORDER_PAID, TRANSACTION_VOID |
--forward | string | Địa chỉ handler trên máy, ví dụ localhost:3000 (bỏ trống thì CLI hỏi) |
--forward-credentials | bool | Chuyển header xác thực (Authorization, X-Secret-Key) tới handler không phải loopback; mặc định không chuyển |
--forward-retries | int | Số lần gửi lại khi chuyển tới handler thất bại, theo lịch của SePay (0 là không gửi lại); mặc định 7 |
--headers | bool | In header của request chuyển tiếp |
--order | string | Chỉ chuyển IPN của mã thanh toán này |
--print | bool | In thêm toàn bộ payload của sự kiện |
--reconnect-max | int | Số lần kết nối lại tối đa (0 là không giới hạn) |
--skip-tls-verify | bool | Bỏ kiểm tra TLS cho handler https trên máy (khi đó không chuyển header xác thực) |
pg ipn set
Đặt địa chỉ nhận IPN cổng thanh toán.
$ sepay pg ipn set <url>| Flag | Kiểu | Mô tả |
|---|---|---|
--active | bool | Bật (--active) hoặc tắt (--active=false) việc gửi |
--auth-type | string | Kiểu xác thực: SECRET_KEY, hoặc để trống để tắt xác thực |
--content-type | string | Kiểu nội dung của request: application/json |
--secret | string | Secret dùng chung, SePay gửi trong header X-Secret-Key; - để đọc từ stdin (đồng thời bật xác thực) |
pg merchant get
Xem thông tin merchant.
$ sepay pg merchant getshowpg order cancel
Hủy đơn chuyển khoản khách chưa thanh toán.
$ sepay pg order cancel <invoice-number>pg order get
Xem một đơn hàng và các giao dịch của nó.
$ sepay pg order get <invoice-number>pg:readpg order list
Liệt kê đơn hàng.
$ sepay pg order listpg:readls| Flag | Kiểu | Mô tả |
|---|---|---|
--customer | string | Lọc theo mã khách hàng |
--from | string | Từ ngày (YYYY-MM-DD) |
--page | int | Số trang |
--per-page | int | Số dòng mỗi trang (tối đa 100) |
--search | string | Tìm theo mã thanh toán hoặc mã đơn hàng |
--status | string | Lọc theo trạng thái đơn, ví dụ CAPTURED, CANCELLED, AUTHENTICATION_NOT_NEEDED (giá trị sai thì CLI in danh sách giá trị hợp lệ) |
--to | string | Đến ngày (YYYY-MM-DD) |
pg order void
Hủy giao dịch thẻ đã thanh toán, trước mốc quyết toán.
$ sepay pg order void <invoice-number>Bank Hub
Viết tắt của nhóm: bh. Hướng dẫn kèm ví dụ: Bank Hub.
bankhub auth
Xem hoặc lấy lại credential Bank Hub sandbox.
$ sepay bankhub auth| Flag | Kiểu | Mô tả |
|---|---|---|
--insecure-storage | bool | Lưu credential trong tệp 0600 thay vì keychain |
--refresh | bool | Lấy bộ credential mới |
bankhub bank-account get
Xem một tài khoản ngân hàng và các VA của nó.
$ sepay bankhub bank-account get <bank-account-xid>bankhub bank-account list
Liệt kê tài khoản ngân hàng đã liên kết.
$ sepay bankhub bank-account listls| Flag | Kiểu | Mô tả |
|---|---|---|
--bank | string | Lọc theo id ngân hàng của Bank Hub (một số, không phải mã ngân hàng) |
--company | string | Lọc theo xid công ty |
--page | int | Số trang |
--per-page | int | Số dòng mỗi trang (tối đa 100) |
--search | string | Tìm tài khoản ngân hàng |
bankhub company create
Tạo công ty.
$ sepay bankhub company createnew| Flag | Kiểu | Mô tả |
|---|---|---|
--name | string | Tên đầy đủ của công ty (bắt buộc) |
--status | string | Trạng thái ban đầu: Pending|Active (mặc định Pending) |
bankhub company get
Xem một công ty và cấu hình của nó.
$ sepay bankhub company get <company-xid>bankhub company list
Liệt kê công ty.
$ sepay bankhub company listls| Flag | Kiểu | Mô tả |
|---|---|---|
--page | int | Số trang |
--per-page | int | Số dòng mỗi trang (tối đa 100) |
--search | string | Tìm công ty |
--status | string | Lọc theo trạng thái: Pending|Active|Suspended|Terminated|Cancelled|Fraud |
bankhub company update
Sửa tên, trạng thái hoặc cấu hình mã thanh toán của công ty.
$ sepay bankhub company update <company-xid>edit| Flag | Kiểu | Mô tả |
|---|---|---|
--name | string | Tên đầy đủ mới |
--payment-code | string | Nhận diện mã thanh toán: on|off |
--status | string | Trạng thái mới: Pending|Active|Suspended|Terminated|Cancelled|Fraud |
--transaction-amount | string | Hạn mức giao dịch: số tiền VND nguyên hoặc Unlimited |
bankhub ipn get
Xem địa chỉ nhận IPN Bank Hub.
$ sepay bankhub ipn getshowbankhub ipn listen
Chuyển IPN Bank Hub tới handler trên máy.
$ sepay bankhub ipn listentail| Flag | Kiểu | Mô tả |
|---|---|---|
--bank-account | string | Chỉ chuyển IPN của tài khoản ngân hàng này (xid) |
--events | string[] | Chỉ chuyển các loại sự kiện này, ngăn cách bằng dấu phẩy: transaction_credit, transaction_debit |
--forward | string | Địa chỉ handler trên máy, ví dụ localhost:3000 (bỏ trống thì CLI hỏi) |
--forward-credentials | bool | Chuyển header xác thực (Authorization, X-Secret-Key) tới handler không phải loopback; mặc định không chuyển |
--forward-retries | int | Số lần gửi lại khi chuyển tới handler thất bại, theo lịch của SePay (0 là không gửi lại); mặc định 7 |
--headers | bool | In header của request chuyển tiếp |
--print | bool | In thêm toàn bộ payload của sự kiện |
--reconnect-max | int | Số lần kết nối lại tối đa (0 là không giới hạn) |
--skip-tls-verify | bool | Bỏ kiểm tra TLS cho handler https trên máy (khi đó không chuyển header xác thực) |
bankhub ipn set
Đặt địa chỉ nhận IPN Bank Hub.
$ sepay bankhub ipn set <url>| Flag | Kiểu | Mô tả |
|---|---|---|
--api-key | string | Khóa dùng chung, SePay gửi trong header Authorization: Apikey; - để đọc từ stdin, để trống để tắt xác thực |
bankhub link-token create
Tạo link token liên kết tài khoản, trả về URL trang liên kết.
$ sepay bankhub link-token createnew| Flag | Kiểu | Mô tả |
|---|---|---|
--bank-account | string | Xid tài khoản ngân hàng (bắt buộc với UNLINK_BANK_ACCOUNT) |
--company | string | Xid công ty dùng token (bắt buộc) |
--language | string | Ngôn ngữ trang liên kết: vi|en (mặc định vi) |
--mobile | bool | Đánh dấu luồng của ứng dụng di động |
--purpose | string | Mục đích: LINK_BANK_ACCOUNT|UNLINK_BANK_ACCOUNT|CREATE_VA|DELETE_VA|INACTIVE_VA|ACTIVE_VA (bắt buộc) |
--redirect-uri | string | URL quay về sau khi hoàn tất trên trang liên kết |
--show-token | bool | In giá trị token (mặc định bị che); link-token get chỉ nhận giá trị này |
bankhub link-token get
Xem link token theo giá trị token.
$ sepay bankhub link-token get <link-token>bankhub link-token revoke
Thu hồi link token theo xid.
$ sepay bankhub link-token revoke <link-token-xid>bankhub sandbox simulate-transaction
Giả lập giao dịch tiền vào trên tài khoản ngân hàng (sandbox)
$ sepay bankhub sandbox simulate-transaction| Flag | Kiểu | Mô tả |
|---|---|---|
--amount | int64 | Số tiền VND, lớn hơn 0 (bắt buộc) |
--bank-account | string | Xid tài khoản ngân hàng nhận giao dịch (bắt buộc) |
--content | string | Nội dung giao dịch (bắt buộc) |
--reference | string | Mã tham chiếu (không bắt buộc) |
--type | string | Loại giao dịch: credit|debit; mặc định credit |
bankhub transaction get
Xem một giao dịch.
$ sepay bankhub transaction get <transaction-id>bankhub transaction list
Liệt kê giao dịch.
$ sepay bankhub transaction listls| Flag | Kiểu | Mô tả |
|---|---|---|
--bank-account | string | Lọc theo xid tài khoản ngân hàng |
--company | string | Lọc theo xid công ty |
--from | string | Từ ngày giao dịch (YYYY-MM-DD) |
--page | int | Số trang |
--per-page | int | Số dòng mỗi trang (tối đa 100) |
--search | string | Tìm giao dịch |
--to | string | Đến ngày giao dịch (YYYY-MM-DD) |
--type | string | Lọc theo loại giao dịch: credit|debit |
bankhub webhook list
Xem webhook của merchant (mỗi merchant có một webhook)
$ sepay bankhub webhook listlsgetshowbankhub webhook set
Tạo hoặc thay webhook của merchant.
$ sepay bankhub webhook set <url>| Flag | Kiểu | Mô tả |
|---|---|---|
--active | bool | Bật hay tắt webhook; mặc định true |
--events | string[] | Sự kiện cần nhận: '*' hoặc tên sự kiện ngăn cách bằng dấu phẩy; webhook mới không có flag này thì không nhận sự kiện nào |
--secret | string | Secret để ký, hoặc - để đọc từ stdin |
Hóa đơn điện tử
Viết tắt của nhóm: inv. Hướng dẫn kèm ví dụ: Hóa đơn điện tử.
einvoice account get
Xem một tài khoản hóa đơn điện tử và các mẫu hóa đơn.
$ sepay einvoice account get <account-id>einvoice account list
Liệt kê tài khoản hóa đơn điện tử.
$ sepay einvoice account listls| Flag | Kiểu | Mô tả |
|---|---|---|
--page | int | Số trang |
--per-page | int | Số dòng mỗi trang (tối đa 100) |
einvoice auth
Xem hoặc lấy lại credential hóa đơn điện tử sandbox.
$ sepay einvoice auth| Flag | Kiểu | Mô tả |
|---|---|---|
--insecure-storage | bool | Lưu credential trong tệp 0600 thay vì keychain |
--refresh | bool | Lấy bộ credential mới |
einvoice invoice create
Gửi hóa đơn (bất đồng bộ); dữ liệu là @file, - để đọc từ stdin, hoặc JSON viết thẳng.
$ sepay einvoice invoice create <payload>neweinvoice invoice create-status
Chờ lần tạo hóa đơn tới Success hoặc Failed.
$ sepay einvoice invoice create-status <tracking-code>einvoice invoice get
Xem một hóa đơn và các dòng hàng.
$ sepay einvoice invoice get <reference-code>einvoice:readeinvoice invoice issue
Phát hành hóa đơn nháp (bất đồng bộ), trả về tracking code.
$ sepay einvoice invoice issue <reference-code>einvoice invoice issue-status
Chờ lần phát hành tới Success hoặc Failed.
$ sepay einvoice invoice issue-status <tracking-code>einvoice invoice list
Liệt kê hóa đơn.
$ sepay einvoice invoice listeinvoice:readls| Flag | Kiểu | Mô tả |
|---|---|---|
--from | string | Từ ngày hóa đơn (YYYY-MM-DD) |
--page | int | Số trang |
--per-page | int | Số dòng mỗi trang (tối đa 100) |
--search | string | Tìm theo ký hiệu và số hóa đơn, mã tham chiếu và thông tin người mua |
--source | string | Lọc theo nguồn tạo: manual|api |
--status | string | Lọc theo trạng thái: draft|issued|failed|cancelled |
--to | string | Đến ngày hóa đơn (YYYY-MM-DD) |
--type | string | Lọc theo loại hóa đơn: 1 nháp, 2 hóa đơn mới, 3 đã hủy, 4 thay thế, 5 bị thay thế, 6 điều chỉnh tăng, 7 điều chỉnh giảm, 8 điều chỉnh thông tin, 9 điều chỉnh tăng/giảm, 10 bị điều chỉnh |
einvoice quota
Xem số hóa đơn đã dùng và còn lại.
$ sepay einvoice quotaGọi API trực tiếp
Hướng dẫn kèm ví dụ: Gọi API trực tiếp.
api
Gọi một endpoint bất kỳ của SePay API bằng phiên đăng nhập của CLI.
$ sepay api <path>| Flag | Kiểu | Mô tả |
|---|---|---|
--dry-run | bool | In request ra mà không gửi, kể cả request GET |
-f, --field | string[] | Thêm một trường key=value; lặp flag để thêm nhiều trường |
-H, --header | string[] | Thêm header cho request; lặp flag để thêm nhiều header |
--input | string | Đọc body của request từ tệp, hoặc - để đọc từ stdin |
-X, --method | string | Phương thức HTTP; mặc định GET |
Lệnh khác
completion
Tạo script gợi ý lệnh cho shell.
$ sepay completion <bash|zsh|fish|powershell>quota
Xem hạn mức gói dịch vụ và mức đã dùng.
$ sepay quotaTrên production, bảng có dòng transaction (giao dịch trong chu kỳ gói) và dòng einvoice (số hóa đơn điện tử còn lại). Dòng einvoice chỉ có USED và REMAINING (unlimited khi gói không giới hạn), vì hệ thống chỉ lưu số hóa đơn còn lại, không có tổng và chu kỳ. Trong -o json: quotas.einvoice là { "used": 12, "remaining": 88 } hoặc { "used": 12, "unlimited": true }. Lệnh chỉ đọc nên chạy cả production; cần scope read, và là Admin hoặc SuperAdmin của công ty (không thì exit code 8).
update
Cập nhật sepay lên bản mới nhất.
$ sepay updateupgrade| Flag | Kiểu | Mô tả |
|---|---|---|
--check | bool | Chỉ báo có bản mới hay không, không cài |
--version | string | Cài đúng bản này thay vì bản mới nhất, ví dụ 0.2.0 |
version
In phiên bản và thông tin bản build.
$ sepay versionhelp
In hướng dẫn của một lệnh hoặc một chủ đề tra cứu.
$ sepay help [command | topic]Chủ đề tra cứu: environment (biến môi trường và tệp cấu hình), errors (giá trị error_code và cách xử lý), exit-codes (exit code), glossary (thuật ngữ). Gõ sepay <chủ đề> cũng in được. Chủ đề không có thì lệnh báo unknown help topic và thoát với code 2.