Balance
# 1. Tổng quan
- Action url:
/api/v1/bamboo/manager/balance - Đặc tả chi tiết:Swagger Link (opens new window)
- Tính năng này cho phép lấy thông tin số dư tài khoản Bamboo Airways (tổng và theo từng cổng thanh toán - gate)
# 2. Hướng dẫn sử dụng
- Thực hiện request từ thông tin mã máy bay để lấy thông tin số dư tài khoản
- Gửi POST tới API action URL để nhận về kết quả
- Nhận về response và xử lý dữ liệu ở phía ứng dụng của đại lý.
# 3. Parameters
# Bảng mô tả Parameters
| Thuộc tính | Bắt buộc | Kiểu dữ liệu | Mô tả |
|---|---|---|---|
'x-api-token' | Có | String | Token API (F10) |
'x-api-password' | Có | String | Mật khẩu API (F10) |
'x-api-account' | Có | String | Tài khoản API (F10) |
# 4. Response
# 4.1 Ví dụ Response
{
"statusCode": 200,
"timestamp": "2025-10-27T02:53:10.544Z",
"path": "/api/v1/bamboo/manager/balance",
"message": "Lấy số dư tài khoản Bamboo Airways thành công",
"data": {
"success": true,
"id": "1761533590215-863m1",
"message": [
{
"message": "Lấy số dư thành công từ 1/1 gates"
}
],
"data": {
"total_amount": 0,
"currency": "VND",
"gate_results": [
{
"gateId": "68be3a77d4b096195",
"gateName": "BGT-QH",
"success": true,
"data": {
"amount": 0,
"currency": "VND"
},
"response": {
"data": {
"amount": 0,
"currency": "VND"
},
"id": "",
"message": [
{
"message": "Thành công!"
}
],
"success": true
}
}
],
"successful_gates": 1,
"total_gates": 1
}
},
"errors": null
}
# 4.2 Response (top-level)
| Thuộc tính | Kiểu dữ liệu | Mô tả | Ví dụ |
|---|---|---|---|
'statusCode' | number (integer) | Mã trạng thái HTTP. | |
'timestamp' | string (ISO 8601) | Thời điểm phản hồi. | |
'path' | string | Đường dẫn API. | |
'message' | string | Thông báo chung. | |
'data' | `object`` | Khối dữ liệu chi tiết. | |
'errors' | array<object> \| null | Danh sách lỗi nếu có. |
# 4.3 data
| Thuộc tính | Kiểu dữ liệu | Mô tả | Ví dụ |
|---|---|---|---|
'success' | boolean | Trạng thái thành công phía Bamboo. | |
'id' | string | ID truy vết/yêu cầu. | |
'message' | array<object> | Danh sách thông điệp trả về. | |
'data' | object | Dữ liệu số dư tài khoản và theo gate. |
# 4.4 data.data
| Thuộc tính | Kiểu dữ liệu | Mô tả | Ví dụ |
|---|---|---|---|
'total_amount' | number | Tổng số dư cộng gộp từ tất cả các gate. | |
'currency' | string (ISO-4217) | Tiền tệ của tổng số dư. | |
'gate_results' | array<object> | Danh sách kết quả theo từng cổng thanh toán (gate). | |
'successful_gates' | number (integer) | Số gate truy vấn thành công. | |
'total_gates' | number (integer) | Tổng số gate được truy vấn. |
# 4.5 data.data.gate_results[]
| Thuộc tính | Kiểu dữ liệu | Mô tả | Ví dụ |
|---|---|---|---|
'gateId' | string | Định danh gate. | |
'gateName' | string | Tên gate. | |
'success' | boolean | Trạng thái thành công khi truy vấn gate. | |
'data' | object | Số dư do gate trả về (đơn giản hóa). | |
'response' | object | Phản hồi chi tiết gốc từ gate. |
# 4.6 data.data.gate_results[].data
| Thuộc tính | Kiểu dữ liệu | Mô tả | Ví dụ |
|---|---|---|---|
'amount' | number | Số dư tại gate. | |
'currency' | string (ISO-4217) | Tiền tệ tại gate. |
# 4.7 data.data.gate_results[].response
| Thuộc tính | Kiểu dữ liệu | Mô tả | Ví dụ |
|---|---|---|---|
'data' | object | Payload dữ liệu của gate. | |
'id' | string | ID giao dịch/phản hồi của gate (nếu có). | |
'message' | array<object> | Thông điệp do gate trả về. | |
'success' | boolean | Trạng thái thành công từ gate. |
# 4.8 data.data.gate_results[].response.data
| Thuộc tính | Kiểu dữ liệu | Mô tả | Ví dụ |
|---|---|---|---|
'amount' | number | Số dư tại gate trong payload gốc. | |
'currency' | string (ISO-4217) | Tiền tệ tại gate trong payload gốc. |