Callback / Webhooks - Đơn hàng

Mô tả dữ liệu đối tác nhận được khi hệ thống gửi callback về trạng thái và thông tin thanh toán của đơn hàng do đối tác tạo.

Về trang chủ Partner API Documentation

⚠️ Yêu cầu xác thực Webhook (Authentication Required)

Tất cả các callback POST từ hệ thống đến đối tác đều bắt buộc phải được xác thực để đảm bảo tính an toàn và bảo mật. Vui lòng đọc kỹ hướng dẫn cấu hình và kiểm tra chữ ký số tại trang: Hướng dẫn xác thực Webhook Callback.

Phạm vi dữ liệu

Chỉ truy cập những dữ liệu mà đối tác tạo ra.

Cấu trúc payload callback

{
  "callbackData": {
    "orderId": 123456,
    "orderRefId": "REQ_202605150001",
    "orderName": "Đơn mua gói dịch vụ",
    "orderCode": "ORD-20260515-0001",
    "orderStatus": 3,
    "paymentStatus": "Success",
    "subTotalAmount": 91000,
    "discountAmount": 0,
    "taxAmount": 0,
    "totalAmount": 91000,
    "paidAmount": 91000,
    "extraFee": 0,
    "paymentMethodType": 13,
    "orderType": 1,
    "orderCategory": 1,
    "createdAt": "2026-05-15T10:20:30.000Z",
    "updatedAt": "2026-05-15T10:20:40.000Z",
    "customerData": {
      "customerIdentifier": "0909123456"
    },
    "vehicleData": {
      "vehicleIdentity": "30A12345",
      "vehiclePlateColor": "YELLOW",
      "vehicleType": 1,
      "chassisNumber": "VSHGA12345678901"
    },
    "customerSchedule" : {
      "customerScheduleId": 100001,
      "licensePlates": "30A84812",
      "licensePlateColor": 1,
      "vehicleType": 1,
      "phone": "0382716917",
      "fullnameSchedule": "Nguyễn Văn An",
      "email": "nguyenvanan@example.com",
      "dateSchedule": "19/06/2026",
      "time": "7h30-8h00",
      "scheduleSerial": 1,
      "scheduleCode": "SCH-20260619-0001",
      "customerScheduleStatus": 3,
      "scheduleNote": "Xe đến đúng hẹn, kiểm định lần đầu",
      "scheduleType": 1,
      "scheduleHash": "d4f8a2b1c9e3f7a0b5d6e2c8f1a3b9d7",
      "confirmStatus": 1,
      "scheduleTracking": "TRK-20260619-100001",
      "createdAt": "2026-06-16T08:30:00.000Z",
      "updatedAt": "2026-06-16T08:30:15.000Z"
    }
  }
}

Dữ liệu callback

Field Type Mô tả
customerData object Thông tin khách hàng.
vehicleData object Thông tin phương tiện.
callbackData object Thông tin chi tiết đơn hàng.

Chi tiết customerData

Field Type Mô tả
customerIdentifier string Định danh khách hàng đã được làm sạch tiền tố đối tác (có thể là số điện thoại, username, hoặc UUID).

Chi tiết vehicleData

Field Type Mô tả
vehicleIdentity string Biển số xe hoặc định danh phương tiện.
vehiclePlateColor string Màu biển số xe. Xem bảng VEHICLE_PLATE_TYPE bên dưới.
vehicleType number Loại phương tiện.
chassisNumber string Số khung xe (VIN).

Chi tiết customerSchedule

Field Type Mô tả
customerSchedule object Thông tin lịch hẹn đăng ký. Xem chi tiết tại Callback_LichHen

Chi tiết callbackData

Field Type Mô tả
orderId number Mã đơn hàng nội bộ.
orderRefId string Mã đơn hàng/phiên giao dịch do đối tác gửi sang.
orderName string Tên hiển thị của đơn hàng.
orderCode string Mã định danh đơn hàng.
orderStatus number Trạng thái xử lý đơn hàng.
paymentStatus string Trạng thái thanh toán của đơn hàng.
subTotalAmount number Tổng tiền trước thuế và giảm giá.
discountAmount number Số tiền được giảm.
taxAmount number Tiền thuế của đơn hàng.
totalAmount number Tổng tiền cần thanh toán.
paidAmount number Số tiền đã thanh toán.
extraFee number Phụ phí phát sinh (nếu có).
paymentMethodType number Loại phương thức thanh toán.
orderType number Loại đơn hàng.
orderCategory number Nhóm phân loại đơn hàng.
createdAt datetime Thời điểm bản ghi đơn hàng được tạo.
updatedAt datetime Thời điểm cập nhật gần nhất.

Bảng liệt kê trạng thái

orderStatus - Trạng thái xử lý đơn hàng

Giá trị Tên Mô tả
0 Chưa xác nhận Đơn hàng mới được tạo.
10 Đã xác nhận Đơn hàng được xác nhận.
20 Đã hủy Đơn hàng bị hủy.
30 Đã đóng Đơn hàng hoàn thành.
40 Đang xử lý Đơn hàng đang được xử lý.

paymentStatus - Trạng thái thanh toán

Giá trị Mô tả
New Tạo mới.
Processing Đang xử lý thanh toán.
Pending Đang chờ thanh toán.
Failed Thanh toán thất bại.
Success Thanh toán thành công.
Canceled Đã hủy đơn hàng.

orderType - Loại đơn hàng

Giá trị Mô tả
1 Kiểm định phương tiện.
2 Thông báo tự động vi phạm phạt nguỗi.
3 Thanh toán tiền tip.
4 Đơn hàng thử nghiệm.
6 Bảo hiểm TNDS Xe máy.
7 Bảo hiểm TNDS Ô tô.
8 Bảo hiểm Thân vỏ Ô tô.
9 Đơn hàng từ bên ngoài.

orderCategory - Phân loại đơn hàng

Giá trị Mô tả
1 Đơn hàng bình thường.
2 Đơn hàng có các sản phẩm được tặng.

vehiclePlateColor - Màu biển số xe (VEHICLE_PLATE_TYPE)

Giá trị Mô tả
WHITE Trắng.
YELLOW Vàng.
BLUE Xanh.
RED Đỏ.