API hủy VA theo đơn hàng

Hủy đơn hàng

DELETE

https://userapi.sepay.vn/v2/bank-accounts/{ba_xid}/orders/{order_xid}

Lưu ý

Chỉ đơn hàng trạng thái Pending mới có thể hủy. Khi hủy, hệ thống đồng thời chuyển toàn bộ VA Unpaid của đơn hàng sang Cancelled.

Tham số

ba_xidstringrequired

UUID tài khoản ngân hàng

order_xidstringrequired

UUID đơn hàng

Code mẫu

curl --request DELETE \
  --url https://userapi.sepay.vn/v2/bank-accounts/f9e8d7c6-b5a4-3210-fedc-ba0987654321/orders/b2c3d4e5-f6a7-8901-bcde-f12345678902 \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response (HTTP 204)

Body rỗng.

Quy tắc hủy theo ngân hàng

Hành vi	BIDV	Sacombank	Vietcombank	VietinBank	Shinhan Bank
Hủy đơn hàng và VA `Unpaid`	Có	Có	Có	Có	Có
Có thể trả lỗi từ chối hủy	Không	Không	Có: `403 vcb_cancel_not_allowed`, `500 vcb_cancel_error`, hoặc `503 vcb_connection_error`	Không	Có: `500 shinhan_cancel_error` hoặc `503 shinhan_connection_error`

Đơn hàng Vietcombank

Đơn hàng Vietcombank có thể không hủy được nếu hóa đơn đã thanh toán hoặc đã hủy ở phía Vietcombank. Tham khảo bảng lỗi bên dưới.

Đơn hàng Shinhan Bank

SePay hủy mọi VA Unpaid của đơn hàng với ngân hàng trước, rồi mới đóng đơn hàng. Nhờ vậy số VA ngừng nhận tiền ngay khi bạn nhận response thành công. Nếu ngân hàng từ chối hủy, đơn hàng giữ nguyên Pending và bạn gọi lại được, vì thao tác hủy không tạo tác dụng phụ khi lặp.

Lỗi

HTTP	error_code	Mô tả
403	`vcb_cancel_not_allowed`	Vietcombank: hóa đơn đã thanh toán hoặc đã hủy, không thể hủy được nữa. Liên hệ SePay nếu cần hỗ trợ.
422	`invalid_state`	Trạng thái đơn hàng không cho phép hủy (chỉ hủy được đơn hàng `Pending`)
500	`vcb_cancel_error`	Vietcombank: lỗi không xác định khi hủy. Liên hệ SePay.
503	`vcb_connection_error`	Vietcombank: dịch vụ tạm thời gián đoạn. Vui lòng thử lại sau ít phút.