Danh sách lệnh SePay CLI

Tra cứu mọi lệnh SePay CLI kèm flag riêng, môi trường chạy, scope cần có trên production và các lệnh hỏi xác nhận hoặc không hoàn tác được.

||

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
SandboxProduction
FlagKiểuMô tả
--insecure-storageboolLưu token trong tệp 0600 thay vì keychain
--scopesstringScope 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-tokenboolĐọ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
SandboxProduction
Hỏi xác nhận tùy cách gọi
FlagKiểuMô tả
--allboolĐăng xuất mọi profile đã lưu
--localboolXó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
SandboxProduction
FlagKiểuMô tả
--remove-scopesstringScope cần bỏ, ngăn cách bằng dấu phẩy
--reset-scopesboolBỏ qua scope hiện tại, chỉ giữ các scope trong --scopes
--scopesstringScope 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]
SandboxProduction
Hỏi xác nhận tùy cách gọiKhông hoàn tác được
FlagKiểuMô tả
--allboolThu hồi mọi phiên của tài khoản
--tokenstringThu 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 sessions
SandboxProduction

auth status

Xem các profile đã lưu và profile mặc định.

$ sepay auth status
SandboxProduction
Viết tắt
stls
FlagKiểuMô tả
--activeboolChỉ hiện profile mặc định

auth switch

Đổi profile mặc định.

$ sepay auth switch <profile>
SandboxProduction
Viết tắt
sw

auth token

In refresh token đang lưu.

$ sepay auth token
SandboxProduction

login

Đăng nhập SePay.

$ sepay login
SandboxProduction
FlagKiểuMô tả
--insecure-storageboolLưu token trong tệp 0600 thay vì keychain
--scopesstringScope 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-tokenboolĐọ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
SandboxProduction
Hỏi xác nhận tùy cách gọi
FlagKiểuMô tả
--allboolĐăng xuất mọi profile đã lưu
--localboolXó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]
SandboxProduction
Viết tắt
listls

config set

Đặt một thiết lập và lưu vào config.yml.

$ sepay config set <key> <value>
SandboxProduction
Hỏi xác nhận tùy cách gọi

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 create
SandboxProduction
Scope
webhook:write
Viết tắt
new
Production: bạn tự xác nhận trên terminal
FlagKiểuMô tả
--auth-typestringKiểu xác thực: none|apikey|hmac|oauth2
--bank-accountstring[]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-configstring[]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-modestringPhạm vi tài khoản: single|multi|all (bắt buộc khi tạo mà CLI không hỏi được)
--content-typestringKiểu nội dung của request: json|form|multipart
--dry-runboolChạ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-typestringLoại sự kiện: all|in|out; mặc định all
--listen-onlyboolKhông có URL nhận; xem sự kiện bằng sepay webhook listen (chỉ sandbox)
--namestringTên webhook
--oauth2-client-idstringClient ID OAuth2 (với --auth-type oauth2)
--oauth2-client-secretstringClient secret OAuth2 (với --auth-type oauth2), hoặc - để đọc từ stdin
--oauth2-token-urlstringURL lấy access token OAuth2 (với --auth-type oauth2)
--only-vaboolChỉ giao dịch qua VA
--prefix-filterstring[]Chỉ chuyển giao dịch có các tiền tố mã thanh toán này
--secretstringSecret dùng chung cho xác thực apikey, hmac; - để đọc từ stdin
--skip-if-no-codeboolBỏ qua giao dịch không có mã thanh toán
--urlstringURL nhận webhook (bắt buộc, trừ khi có --listen-only)
--va-xidstring[]Xid VA áp dụng; lặp flag để chọn nhiều VA
--verify-paymentboolChỉ chuyển giao dịch đã xác thực

webhook delete

Xóa webhook.

$ sepay webhook delete <webhook-xid>
SandboxProduction
Scope
webhook:write
Viết tắt
rmdel
Luôn hỏi xác nhậnProduction: bạn tự xác nhận trên terminalKhông hoàn tác được
FlagKiểuMô tả
--dry-runboolChạ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>
SandboxProduction

webhook list

Liệt kê webhook.

$ sepay webhook list
SandboxProduction
Viết tắt
ls
FlagKiểuMô tả
--activestringLọc theo trạng thái: 0|1
--pageintSố trang
--per-pageintSố 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 listen
SandboxProduction
Viết tắt
tail
FlagKiểuMô tả
--eventsstring[]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
--forwardstringĐịa chỉ handler trên máy, ví dụ localhost:3000 (bỏ trống thì CLI hỏi)
--forward-credentialsboolChuyể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-retriesintSố 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
--headersboolIn header của request chuyển tiếp
--printboolIn thêm toàn bộ payload của sự kiện
--reconnect-maxintSố lần kết nối lại tối đa (0 là không giới hạn)
--skip-tls-verifyboolBỏ kiểm tra TLS cho handler https trên máy (khi đó không chuyển header xác thực)
--webhookstringChỉ 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]
SandboxProduction
Viết tắt
log
FlagKiểuMô tả
--pageintSố trang
--per-pageintSố dòng mỗi trang (tối đa 100)
--sincestringChỉ log từ thời điểm này: khoảng thời gian (24h), ngày hoặc ngày giờ
--statusstringLọc theo kết quả gửi: success|failed|listen|skipped
--transactionstringLọc theo mã giao dịch
--untilstringChỉ log đến ngày hoặc ngày giờ này (chỉ ghi ngày thì tính hết ngày đó)
--webhookstringLọ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]
SandboxProduction
Scope
webhook:write
Luôn hỏi xác nhậnProduction: bạn tự xác nhận trên terminal
FlagKiểuMô tả
--dry-runboolChạ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)
--forceboolGử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
--transactionstringMã giao dịch của lần gửi (giống đối số)
--webhookstringXid 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
SandboxProduction
FlagKiểuMô tả
--amountint64Số tiền VND (bắt buộc)
--bank-accountstringXid tài khoản ngân hàng sandbox nhận sự kiện
--eventstringLoại sự kiện cần gửi: payment_in, payment_out, va_credit; mặc định payment_in
--expect-statusintHTTP status mong đợi (0 là mọi mã 2xx)
--forwardstringĐịa chỉ handler trên máy, ví dụ localhost:3000 (bắt buộc)
--forward-credentialsboolChuyể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
--timeoutdurationThời gian chờ handler; mặc định 10s
--vastringSố VA (với va_credit)
--webhookstringChỉ 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>
SandboxProduction
Scope
webhook:write
Viết tắt
edit
Production: bạn tự xác nhận trên terminal
FlagKiểuMô tả
--auth-typestringKiểu xác thực: none|apikey|hmac|oauth2
--bank-accountstring[]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-configstring[]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-modestringPhạm vi tài khoản: single|multi|all (bắt buộc khi tạo mà CLI không hỏi được)
--content-typestringKiểu nội dung của request: json|form|multipart
--dry-runboolChạ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-typestringLoại sự kiện: all|in|out; mặc định all
--listen-onlyboolKhông có URL nhận; xem sự kiện bằng sepay webhook listen (chỉ sandbox)
--namestringTên webhook
--oauth2-client-idstringClient ID OAuth2 (với --auth-type oauth2)
--oauth2-client-secretstringClient secret OAuth2 (với --auth-type oauth2), hoặc - để đọc từ stdin
--oauth2-token-urlstringURL lấy access token OAuth2 (với --auth-type oauth2)
--only-vaboolChỉ giao dịch qua VA
--prefix-filterstring[]Chỉ chuyển giao dịch có các tiền tố mã thanh toán này
--secretstringSecret dùng chung cho xác thực apikey, hmac; - để đọc từ stdin
--skip-if-no-codeboolBỏ qua giao dịch không có mã thanh toán
--urlstringURL nhận webhook (bắt buộc, trừ khi có --listen-only)
--va-xidstring[]Xid VA áp dụng; lặp flag để chọn nhiều VA
--verify-paymentboolChỉ 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>
SandboxProduction

transaction list

Liệt kê giao dịch.

$ sepay transaction list
SandboxProduction
Viết tắt
ls
FlagKiểuMô tả
--amount-in-maxstringTiền vào tối đa
--amount-in-minstringTiền vào tối thiểu
--amount-in-sortstringSắp xếp theo tiền vào: asc|desc
--amount-out-maxstringTiền ra tối đa
--amount-out-minstringTiền ra tối thiểu
--amount-out-sortstringSắp xếp theo tiền ra: asc|desc
--bankstringLọc theo ngân hàng, ví dụ ACB, BIDV
--bank-accountstringLọc theo xid tài khoản ngân hàng
--fieldsstringCác trường cần trả về, ngăn cách bằng dấu phẩy
--fromstringNgày bắt đầu, tính cả ngày này (YYYY-MM-DD)
--pageintSố trang
--per-pageintSố dòng mỗi trang (tối đa 100)
--reference-numberstringLọc theo mã tham chiếu (khớp chính xác)
--searchstringTìm theo mã tham chiếu, nội dung hoặc mã thanh toán
--since-idstringTrả về các giao dịch sau xid này
--tostringNgày kết thúc, tính cả ngày này (YYYY-MM-DD)
--transaction-contentstringLọc theo nội dung
--transaction-date-sortstringSắp xếp theo ngày: asc|desc
--transfer-typestringLọc theo chiều tiền: in|out
--va-xidstringLọc theo xid VA
--webhook-successstringLọ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 create
SandboxProduction
Viết tắt
new
FlagKiểuMô tả
--account-typestringindividual|business_household|enterprise (bắt buộc)
--bankstringMã ngân hàng, ví dụ ACB (bắt buộc)
--connectionstringsms|api; sms chỉ dùng được với gói còn hỗ trợ SMS; mặc định api
--holder-namestringTên chủ tài khoản; tự tạo nếu bỏ trống
--labelstringNhã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>
SandboxProduction
Viết tắt
rmdel
Luôn hỏi xác nhậnKhông hoàn tác được

bank-account get

Xem một tài khoản ngân hàng.

$ sepay bank-account get <bank-account-xid>
SandboxProduction

bank-account list

Liệt kê tài khoản ngân hàng.

$ sepay bank-account list
SandboxProduction
Viết tắt
ls
FlagKiểuMô tả
--accumulated-maxstringSố dư lũy kế tối đa
--accumulated-minstringSố dư lũy kế tối thiểu
--accumulated-sortstringSắp xếp theo số dư: asc|desc
--activestringLọc theo trạng thái: 0|1|true|false
--bankstringLọc theo ngân hàng, ví dụ ACB, BIDV
--created-at-sortstringSắp xếp theo ngày tạo: asc|desc
--last-transaction-fromstringGiao dịch gần nhất từ ngày này trở đi (YYYY-MM-DD)
--last-transaction-sortstringSắp xếp theo giao dịch gần nhất: asc|desc
--last-transaction-tostringGiao dịch gần nhất tới hết ngày này (YYYY-MM-DD)
--pageintSố trang
--per-pageintSố dòng mỗi trang (tối đa 100)
--searchstringTì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>
SandboxProduction
Scope
bank-account:write
Viết tắt
edit
Production: bạn tự xác nhận trên terminal
FlagKiểuMô tả
--dry-runboolChạ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)
--labelstringNhã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>
SandboxProduction
FlagKiểuMô tả
--bank-accountstringXid 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
SandboxProduction
FlagKiểuMô tả
--bank-accountstringXid tài khoản ngân hàng sẽ chứa VA (bắt buộc)
--labelstringNhãn hiển thị
--terminal-namestringTên terminal (Vietcombank OneQR, tự tạo terminal)
--tidstringMã terminal (Vietcombank OneQR)

va list

Liệt kê VA của một tài khoản ngân hàng.

$ sepay va list
SandboxProduction
Viết tắt
ls
FlagKiểuMô tả
--activestringLọc theo trạng thái: 0|1|true|false
--bank-accountstringXid tài khoản ngân hàng chứa VA
--created-at-sortstringSắp xếp theo ngày tạo: asc|desc
--officialstringLọc VA chính thức: 0|1
--pageintSố trang
--per-pageintSố dòng mỗi trang (tối đa 100)
--searchstringTìm theo số VA hoặc nhãn
--staticstringLọc VA cố định: 0|1

va revoke

Thu hồi VA (chỉ sandbox)

$ sepay va revoke <va-xid|va-number>
SandboxProduction
Luôn hỏi xác nhậnKhông hoàn tác được
FlagKiểuMô tả
--bank-accountstringXid 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]
SandboxProduction
Scope
paycode:write
Production: bạn tự xác nhận trên terminal
FlagKiểuMô tả
--activeboolBật (--active) hoặc tắt (--active=false) cấu trúc (bắt buộc)
--character-typestringNumberOnly (chỉ số) hoặc NumberAndLetter (số và chữ) (bắt buộc)
--dry-runboolChạ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)
--prefixstringTiề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-fromintĐộ 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-tointĐộ 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 list
SandboxProduction
Viết tắt
ls

paycode 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]
SandboxProduction
Scope
paycode:write
Viết tắt
edit
Production: bạn tự xác nhận trên terminal
FlagKiểuMô tả
--activeboolBật (--active) hoặc tắt (--active=false) cấu trúc này; mặc định true
--character-typestringNumberOnly (chỉ số) hoặc NumberAndLetter (số và chữ)
--disableboolTắt nhận diện mã thanh toán
--dry-runboolChạ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)
--enableboolBật nhận diện mã thanh toán
--prefixstringTiề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
--structurestringTiề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-fromintĐộ 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-tointĐộ 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
SandboxProduction
FlagKiểuMô tả
--bankstringMã 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
--seedintTạo số giao dịch mẫu này (tối đa 100)
--with-vaboolCấp thêm một VA
--with-webhookstringTạo thêm webhook gửi tới URL này
--with-webhook-listenboolTạ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 reset
SandboxProduction
Luôn hỏi xác nhậnKhông hoàn tác được

sandbox seed

Thêm giao dịch mẫu vào sandbox.

$ sepay sandbox seed
SandboxProduction
FlagKiểuMô tả
--bank-accountstringXid tài khoản ngân hàng nhận giao dịch mẫu (bắt buộc)
--countintSố 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]
SandboxProduction
FlagKiểuMô tả
--amountint64Số tiền VND (bắt buộc)
--bank-accountstringXid tài khoản ngân hàng (bắt buộc)
--codestringMã thanh toán (tối đa 10 ký tự)
--eventstringLoại sự kiện (hoặc truyền làm đối số): payment_in, payment_out, va_credit
--overridestring[]Ghi đè trường trong payload dạng key=val; lặp flag để ghi đè nhiều trường (chỉ hỗ trợ content)
--vastringSố 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 create
SandboxProduction
Viết tắt
new
FlagKiểuMô tả
--activeboolTạo key ở trạng thái bật; mặc định true
--namestringTên key (bắt buộc)

apikey delete

Xóa API key (chỉ sandbox)

$ sepay apikey delete <api-key-xid>
SandboxProduction
Viết tắt
rmdel
Luôn hỏi xác nhậnKhông hoàn tác được

apikey get

Xem một API key (chỉ sandbox)

$ sepay apikey get <api-key-xid>
SandboxProduction

apikey list

Liệt kê API key (chỉ sandbox)

$ sepay apikey list
SandboxProduction
Viết tắt
ls

apikey update

Đổi tên hoặc trạng thái API key (chỉ sandbox)

$ sepay apikey update <api-key-xid>
SandboxProduction
Viết tắt
edit
FlagKiểuMô tả
--activeboolBật (--active) hoặc tắt (--active=false) key; mặc định true
--namestringTê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
SandboxProduction
FlagKiểuMô tả
--insecure-storageboolLưu credential trong tệp 0600 thay vì keychain
--refreshboolLấy bộ credential mới

pg checkout init

Tạo đơn và trả về URL trang thanh toán.

$ sepay pg checkout init
SandboxProduction
FlagKiểuMô tả
--amountstringSố tiền đơn hàng (bắt buộc)
--cancel-urlstringURL chuyển về khi khách hủy
--currencystringTiền tệ; mặc định VND
--customerstringMã khách hàng
--descriptionstringMô tả đơn hàng (bắt buộc)
--error-urlstringURL chuyển về khi lỗi
--invoicestringMã đơn hàng: chữ, số, - và _ (bắt buộc với PURCHASE)
--no-openboolIn URL, không mở trình duyệt
--operationstringPURCHASE|VERIFY; mặc định PURCHASE
--payment-methodstringBANK_TRANSFER|CARD|NAPAS_BANK_TRANSFER (không bắt buộc)
--success-urlstringURL 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 get
SandboxProduction
Viết tắt
show

pg ipn listen

Chuyển IPN cổng thanh toán tới handler trên máy.

$ sepay pg ipn listen
SandboxProduction
Viết tắt
tail
FlagKiểuMô tả
--eventsstring[]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
--forwardstringĐịa chỉ handler trên máy, ví dụ localhost:3000 (bỏ trống thì CLI hỏi)
--forward-credentialsboolChuyể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-retriesintSố 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
--headersboolIn header của request chuyển tiếp
--orderstringChỉ chuyển IPN của mã thanh toán này
--printboolIn thêm toàn bộ payload của sự kiện
--reconnect-maxintSố lần kết nối lại tối đa (0 là không giới hạn)
--skip-tls-verifyboolBỏ 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>
SandboxProduction
Luôn hỏi xác nhận
FlagKiểuMô tả
--activeboolBật (--active) hoặc tắt (--active=false) việc gửi
--auth-typestringKiểu xác thực: SECRET_KEY, hoặc để trống để tắt xác thực
--content-typestringKiểu nội dung của request: application/json
--secretstringSecret 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 get
SandboxProduction
Viết tắt
show

pg order cancel

Hủy đơn chuyển khoản khách chưa thanh toán.

$ sepay pg order cancel <invoice-number>
SandboxProduction
Luôn hỏi xác nhậnKhông hoàn tác được

pg order get

Xem một đơn hàng và các giao dịch của nó.

$ sepay pg order get <invoice-number>
SandboxProduction
Scope
pg:read

pg order list

Liệt kê đơn hàng.

$ sepay pg order list
SandboxProduction
Scope
pg:read
Viết tắt
ls
FlagKiểuMô tả
--customerstringLọc theo mã khách hàng
--fromstringTừ ngày (YYYY-MM-DD)
--pageintSố trang
--per-pageintSố dòng mỗi trang (tối đa 100)
--searchstringTìm theo mã thanh toán hoặc mã đơn hàng
--statusstringLọ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ệ)
--tostringĐế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>
SandboxProduction
Luôn hỏi xác nhậnKhông hoàn tác được

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
SandboxProduction
FlagKiểuMô tả
--insecure-storageboolLưu credential trong tệp 0600 thay vì keychain
--refreshboolLấ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>
SandboxProduction

bankhub bank-account list

Liệt kê tài khoản ngân hàng đã liên kết.

$ sepay bankhub bank-account list
SandboxProduction
Viết tắt
ls
FlagKiểuMô tả
--bankstringLọc theo id ngân hàng của Bank Hub (một số, không phải mã ngân hàng)
--companystringLọc theo xid công ty
--pageintSố trang
--per-pageintSố dòng mỗi trang (tối đa 100)
--searchstringTìm tài khoản ngân hàng

bankhub company create

Tạo công ty.

$ sepay bankhub company create
SandboxProduction
Viết tắt
new
FlagKiểuMô tả
--namestringTên đầy đủ của công ty (bắt buộc)
--statusstringTrạ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>
SandboxProduction

bankhub company list

Liệt kê công ty.

$ sepay bankhub company list
SandboxProduction
Viết tắt
ls
FlagKiểuMô tả
--pageintSố trang
--per-pageintSố dòng mỗi trang (tối đa 100)
--searchstringTìm công ty
--statusstringLọ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>
SandboxProduction
Viết tắt
edit
Luôn hỏi xác nhận
FlagKiểuMô tả
--namestringTên đầy đủ mới
--payment-codestringNhận diện mã thanh toán: on|off
--statusstringTrạng thái mới: Pending|Active|Suspended|Terminated|Cancelled|Fraud
--transaction-amountstringHạ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 get
SandboxProduction
Viết tắt
show

bankhub ipn listen

Chuyển IPN Bank Hub tới handler trên máy.

$ sepay bankhub ipn listen
SandboxProduction
Viết tắt
tail
FlagKiểuMô tả
--bank-accountstringChỉ chuyển IPN của tài khoản ngân hàng này (xid)
--eventsstring[]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
--forwardstringĐịa chỉ handler trên máy, ví dụ localhost:3000 (bỏ trống thì CLI hỏi)
--forward-credentialsboolChuyể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-retriesintSố 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
--headersboolIn header của request chuyển tiếp
--printboolIn thêm toàn bộ payload của sự kiện
--reconnect-maxintSố lần kết nối lại tối đa (0 là không giới hạn)
--skip-tls-verifyboolBỏ 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>
SandboxProduction
Luôn hỏi xác nhận
FlagKiểuMô tả
--api-keystringKhóa dùng chung, SePay gửi trong header Authorization: Apikey; - để đọc từ stdin, để trống để tắt xác thực

Tạo link token liên kết tài khoản, trả về URL trang liên kết.

$ sepay bankhub link-token create
SandboxProduction
Viết tắt
new
FlagKiểuMô tả
--bank-accountstringXid tài khoản ngân hàng (bắt buộc với UNLINK_BANK_ACCOUNT)
--companystringXid công ty dùng token (bắt buộc)
--languagestringNgôn ngữ trang liên kết: vi|en (mặc định vi)
--mobileboolĐánh dấu luồng của ứng dụng di động
--purposestringMục đích: LINK_BANK_ACCOUNT|UNLINK_BANK_ACCOUNT|CREATE_VA|DELETE_VA|INACTIVE_VA|ACTIVE_VA (bắt buộc)
--redirect-uristringURL quay về sau khi hoàn tất trên trang liên kết
--show-tokenboolIn giá trị token (mặc định bị che); link-token get chỉ nhận giá trị này

Xem link token theo giá trị token.

$ sepay bankhub link-token get <link-token>
SandboxProduction

Thu hồi link token theo xid.

$ sepay bankhub link-token revoke <link-token-xid>
SandboxProduction
Luôn hỏi xác nhậnKhông hoàn tác được

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
SandboxProduction
FlagKiểuMô tả
--amountint64Số tiền VND, lớn hơn 0 (bắt buộc)
--bank-accountstringXid tài khoản ngân hàng nhận giao dịch (bắt buộc)
--contentstringNội dung giao dịch (bắt buộc)
--referencestringMã tham chiếu (không bắt buộc)
--typestringLoạ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>
SandboxProduction

bankhub transaction list

Liệt kê giao dịch.

$ sepay bankhub transaction list
SandboxProduction
Viết tắt
ls
FlagKiểuMô tả
--bank-accountstringLọc theo xid tài khoản ngân hàng
--companystringLọc theo xid công ty
--fromstringTừ ngày giao dịch (YYYY-MM-DD)
--pageintSố trang
--per-pageintSố dòng mỗi trang (tối đa 100)
--searchstringTìm giao dịch
--tostringĐến ngày giao dịch (YYYY-MM-DD)
--typestringLọ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 list
SandboxProduction
Viết tắt
lsgetshow

bankhub webhook set

Tạo hoặc thay webhook của merchant.

$ sepay bankhub webhook set <url>
SandboxProduction
Luôn hỏi xác nhậnKhông hoàn tác được
FlagKiểuMô tả
--activeboolBật hay tắt webhook; mặc định true
--eventsstring[]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
--secretstringSecret để 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>
SandboxProduction

einvoice account list

Liệt kê tài khoản hóa đơn điện tử.

$ sepay einvoice account list
SandboxProduction
Viết tắt
ls
FlagKiểuMô tả
--pageintSố trang
--per-pageintSố 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
SandboxProduction
FlagKiểuMô tả
--insecure-storageboolLưu credential trong tệp 0600 thay vì keychain
--refreshboolLấ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>
SandboxProduction
Viết tắt
new

einvoice invoice create-status

Chờ lần tạo hóa đơn tới Success hoặc Failed.

$ sepay einvoice invoice create-status <tracking-code>
SandboxProduction

einvoice invoice get

Xem một hóa đơn và các dòng hàng.

$ sepay einvoice invoice get <reference-code>
SandboxProduction
Scope
einvoice:read

einvoice 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>
SandboxProduction
Luôn hỏi xác nhậnKhông hoàn tác được

einvoice invoice issue-status

Chờ lần phát hành tới Success hoặc Failed.

$ sepay einvoice invoice issue-status <tracking-code>
SandboxProduction

einvoice invoice list

Liệt kê hóa đơn.

$ sepay einvoice invoice list
SandboxProduction
Scope
einvoice:read
Viết tắt
ls
FlagKiểuMô tả
--fromstringTừ ngày hóa đơn (YYYY-MM-DD)
--pageintSố trang
--per-pageintSố dòng mỗi trang (tối đa 100)
--searchstringTìm theo ký hiệu và số hóa đơn, mã tham chiếu và thông tin người mua
--sourcestringLọc theo nguồn tạo: manual|api
--statusstringLọc theo trạng thái: draft|issued|failed|cancelled
--tostringĐến ngày hóa đơn (YYYY-MM-DD)
--typestringLọ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 quota
SandboxProduction

Gọ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>
SandboxProduction
Hỏi xác nhận tùy cách gọiProduction: bạn tự xác nhận trên terminal
FlagKiểuMô tả
--dry-runboolIn request ra mà không gửi, kể cả request GET
-f, --fieldstring[]Thêm một trường key=value; lặp flag để thêm nhiều trường
-H, --headerstring[]Thêm header cho request; lặp flag để thêm nhiều header
--inputstringĐọc body của request từ tệp, hoặc - để đọc từ stdin
-X, --methodstringPhươ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>
SandboxProduction

quota

Xem hạn mức gói dịch vụ và mức đã dùng.

$ sepay quota
SandboxProduction

Trê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 update
SandboxProduction
Viết tắt
upgrade
FlagKiểuMô tả
--checkboolChỉ báo có bản mới hay không, không cài
--versionstringCà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 version
SandboxProduction

help

In hướng dẫn của một lệnh hoặc một chủ đề tra cứu.

$ sepay help [command | topic]
SandboxProduction

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.