| Version Number | Author | Executive summary | Release Date |
|---|---|---|---|
| V0.1 | BaoAnh | First edition | 18/12/2024 |
| V0.2 | BaoAnh | Add Publish Ticket, Cancel Ticket, Update Ticket Info | 18/01/2025 |
| V0.3 | BaoAnh | Update host |
| Information | Value |
|---|---|
| Staging | https://stg-api-hub.suntraveltech.com/agent/v1 |
| Username | client_id |
| Password | client_serect |
| Key | secure_key |
| Header | Description |
|---|---|
| Content-Type | application/json |
| Accept | application/json |
| Heading | Type |
|---|---|
| Success | Array or Object |
| Fail | Object |
| Field Name | Description |
|---|---|
| error | Mã lỗi (xem bảng Error Code) |
| error_description | Thông tin mô tả lỗi |
| HTTP Status Code | Error | Error Description |
|---|---|---|
| 500 | internal_server_error | Có lỗi hệ thống |
| 401 | unauthorized | Chưa xác thực |
| 403 | forbidden | Không có quyền truy cập |
| 400 | bad_request | Dữ liệu không hợp lệ |
| 429 | too_many_request | Yêu cầu quá nhiều |
| 400 | invalid_signature | Chữ ký không hợp lệ |
| 404 | provider_not_found | Nhà cung cấp không tìm thấy |
| 404 | provider_disabled | Nhà cung cấp không khả dụng |
| 404 | route_not_found | Tuyến không tìm thấy |
| 404 | route_disabled | Tuyến không khả dụng |
| 404 | vehicle_not_found | Phương tiện không tìm thấy |
| 404 | schedule_not_found | Lịch trình không tìm thấy |
| 404 | schedule_disabled | Lịch trình không khả dụng |
| 404 | seat_not_found | Ghế không tìm thấy |
| 409 | seat_duplicate | Ghế bị trùng lặp |
| 404 | seat_canceled | Ghế đã bị hủy |
| 404 | seat_updated | Ghế đã được cập nhật |
| 404 | seat_booked | Ghế đã được đặt |
| 409 | seat_disabled | Ghế không không khả dụng |
| 400 | cancel_seat_too_late | Không thể hủy ghế trước 48 giờ so với thời gian khởi hành |
| 400 | update_seat_too_late | Không thể cập nhật thông tin hành khách trước 48 giờ so với thời gian khởi hành |
| 404 | price_not_found | Giá không tìm thấy |
| 404 | nation_not_found | Quốc gia không tìm thấy |
| 400 | balance_not_enough | Không đủ số dư |
| 409 | request_id_conflict | Mã yêu cầu đã tồn tại |
| 409 | transaction_id_conflict | Mã giao dịch đã tồn tại |
| 404 | booking_not_found | Đơn hàng không tìm thấy |
| 409 | booking_conflict | Đơn hàng đã tồn tại |
| 400 | booking_identity_conflict | Trùng CMND/CCCD với hành khách đã đặt chỗ |
| 400 | booking_identity_duplicate | CMND/CCCD hành khách bị trùng lặp |
| 400 | booking_paid_amount_incorrect | Số tiền thanh toán không chính xác |
| 400 | booking_ticket_price_incorrect | Giá vé không chính xác |
| 400 | booking_fail | Tạo đơn hàng không thành công |
| 400 | booking_order_incorrect | Thông tin đơn hàng không chính xác |
| 400 | booking_provider_incorrect | Đặt vé khứ hồi chỉ hỗ trợ cùng nhà cung cấp |
| 400 | booking_yob_incorrect | Ngày sinh không hợp lệ. Chỉ hỗ trợ mua vé cho người từ 6 tuổi trở lên |
| 400 | booking_child_unaccompanied | Phải có ít nh ất 1 người người lớn đi cùng trẻ em |
| 400 | booking_unknown | Các lỗi khác (không nằm trong danh sách lỗi đã liệt kê |
| Filed name | Type | Description |
|---|---|---|
| x-pagination-total | number | Tổng số phần tử |
| x-pagination-limit | number | Số phần tử trên mỗi trang |
| x-pagination-page | number | Trang hiện tại |
| Loại | Chi tiết | Note |
|---|---|---|
| Hạng vé: vip, eco, deluxe | - Vip: Hạng VIP vd: V012: Khu vực Vip ghế 12 - Eco: Hạng thường vd: G13: Ghế thuờng hàng 13 cột G - Deluxe: Hạng Deluxe vd: DL05: Ghế duluxe hàng 5 cột L | Hàng Deluxe: Chỉ cóở tuyến HCM - CĐ, mà hiện giờ đang off |
| Loại vé: adults, children, elderly | - baby < 6 tuổi: miễn phí (không cần booking vé) - children 6-12 tuổi - adult 13-59 tuổi - elderly >59 tuổi | - 1 Children phải đi chung với 1 elderly |
| Total amount: Tổng cộng | - Ticket mount: Giá vé theo bảng giá của PQE - Fee habor: Phí theo bảng phí của cảng | |
| QR code | I1Q1CP5LRKK4RGL8QZ674KEWWQ3NZ5L1$TD-CD*02/03/2025 06:30__NGUYEN VAN GUEST 1L_12*_079012345680 | Format QRcode từ Nhà cung cấp trả về |
| Balance | Số dư tài khoản đại lý (tenant) | Sẽ được setup trước khi sử dụng API (1.000.000.000 vnd) |
| Booking | - hệ thống sẽ tạm giữ số tiền theo hold booking - Status of booking: + holding: Sau khi gửi yêu cầu đặt vé thành công + expired: Quá hạn thanh toán + paid: Đã thanh toán + canceled: booking bị huỷ + failed: booking lỗi | - Thời gian hold là: 20 phút - Sau đó, nếu không comfirm booking, số tiền tạm giữ sẽ được hoàn lại balance |
| Publish ticket | Cho phép Xuất vé khi : + Payment thành công (1 lần) + Update thông tin vé (1 lần) | - Không có giới hạn thời gian xuất vé |
| Booking code | Mã tham chiếu booking với nhà cung cấp | vd: Book 1 chiều là 123 Book 2 chiều 123-124 |
| Publish ticket | Cho phép Xuất vé khi : + Payment thành công (1 lần) + Update thông tin vé (1 lần) | - Không có giới hạn thời gian xuất vé |
| Request_id | Mã tham chiếu (unique) do đối tác tự quy định để tra cứu | |
| Transaction_id | Mã tham chiếu (unique) do đối tác tự quy định để tra cứu | |
| Update Ticket Info | Mỗi guest được yêu cầu đổi tên và CCCD 1 lần miễn phí (theo Quy định của nhà cung cấp) | Đại lý sẽ tạo request để HUB xử lý thông tin này với nhà cung cấp |
| Cancel Ticket | Guest có thể yêu cầu huỷ ghế hoặc huỷ booking bị 1 khoản mất phí (theo Quy định của nhà cung cấp) | Đại lý sẽ tạo request để HUB xử lý thông tin này với nhà cung cấp |