Thử tích hợp SePay mà không dùng tiền thật thì dùng sandbox của SePay CLI. Các lệnh sandbox tạo tài khoản ngân hàng thử và giả lập giao dịch trên môi trường này. Công ty cần bật Test mode; SuperAdmin, Admin hoặc người dùng có quyền Developer bật được (xem Test mode).
sandbox init
Tạo tài khoản ngân hàng sandbox, tùy chọn kèm VA, webhook và giao dịch mẫu.
Tham số
| Flag | Kiểu | Bắt buộc | Mô tả |
|---|---|---|---|
--bank | string | Không | Mã ngân hàng của tài khoản thử. Mặc định ACB nếu sandbox hỗ trợ, nếu không thì ngân hàng đầu tiên sandbox hỗ trợ |
--with-va | bool | Không | Tạo kèm một tài khoản ảo (VA). Một số ngân hàng như OCB, KLB, MSB, VCB đã tự có VA đầu tiên khi tạo tài khoản, thêm cờ này sẽ thành hai VA |
--with-webhook | string | Không | Tạo kèm webhook gửi tới URL này |
--with-webhook-listen | bool | Không | Tạo kèm webhook không URL, nhận qua webhook listen |
--seed | int | Không | Số giao dịch mẫu tạo kèm, tối đa 100 |
Ví dụ
$ sepay sandbox init --with-webhook-listen --yesenv: sandboxCreated bank account 832529c1-xxxx-xxxx-xxxx-fa163e2f7c98 (ACB).Created listen-only webhook 5f0e2a7b-xxxx-xxxx-xxxx-fa163e2f7c98.832529c1-xxxx-xxxx-xxxx-fa163e2f7c98Ghi chú
- Dòng cuối là xid của tài khoản. xid là ID SePay gán cho mỗi tài khoản, webhook và giao dịch; các lệnh khác nhận xid này để chỉ đúng đối tượng. Xem lại xid tài khoản bằng
sepay bank-account list(cộtID). --yesdùng giá trị mặc định cho mọi flag không truyền: ngân hàng mặc định của--bank, không VA, không webhook, không giao dịch mẫu.- Mỗi lần chạy tạo thêm tài khoản và webhook mới.
- Nếu một bước bị từ chối giữa chừng, CLI in
! stopped part-way; what it created above already exists: những gì đã tạo vẫn còn. Chạysepay sandbox resetđể xóa sạch rồi chạy lại.
sandbox simulate
Giả lập giao dịch. SePay xử lý như một giao dịch thật và gửi thông báo tới các webhook áp dụng cho tài khoản.
Tham số
| Tham số | Kiểu | Bắt buộc | Mô tả |
|---|---|---|---|
<event> hoặc --event | string | Có | payment_in (tiền vào), payment_out (tiền ra), va_credit (tiền vào VA) |
--bank-account | string | Có | Xid tài khoản ngân hàng sandbox |
--amount | int | Có | Số tiền VND, từ 1.000 đến 499.000.000 |
--code | string | Không | Mã thanh toán, tối đa 10 ký tự (nên dùng không dấu) |
--va | string | Với va_credit | Số VA (không phải xid) |
--override | string[] | Không | Ghi đè trường payload dạng key=val; chỉ hỗ trợ content |
Ví dụ
Tạo giao dịch tiền vào tài khoản ngân hàng, kèm mã thanh toán:
$ sepay sandbox simulate payment_in --bank-account <bank-account-xid> --amount 50000 --code DH1709Tạo giao dịch tiền vào một VA:
$ sepay sandbox simulate va_credit --bank-account <bank-account-xid> --va <số VA> --amount 50000--code điền sẵn mã thanh toán vào webhook (khác gì với nhận diện mã từ nội dung chuyển khoản).
Kết quả
env: sandboxSimulated payment_in event.a41c9e02-xxxx-xxxx-xxxx-fa163e2f7c98Ghi chú
- Dòng cuối là xid giao dịch, dùng với
sepay transaction get.
sandbox seed
Tạo giao dịch mẫu trên một tài khoản sandbox.
| Flag | Kiểu | Bắt buộc | Mô tả |
|---|---|---|---|
--bank-account | string | Có | Xid tài khoản |
--count | int | Không | Số giao dịch, từ 1 đến 100. Mặc định 5 |
$ sepay sandbox seed --bank-account <bank-account-xid> --count 5sandbox reset
Xóa toàn bộ webhook và tài khoản ngân hàng sandbox của công ty, kèm VA và giao dịch của các tài khoản đó.
$ sepay sandbox resetLệnh luôn hỏi xác nhận; không có terminal thì cần --yes.
Tài khoản ngân hàng sandbox
Tạo thêm hoặc xóa tài khoản ngân hàng sandbox bằng bank-account create và bank-account delete, xem Tài khoản ngân hàng.