Refund Amount

1. Tổng quan

• Action url: /api/v1/bamboo/manager/refund-amount
• Đặc tả chi tiết: Swagger Link (opens new window)
• Tính năng này cho phép kiểm tra số tiền hoàn trả cho PNR (Passenger Name Record) Bamboo Airways trước khi thực hiện hủy vé

2. Hướng dẫn sử dụng

1. Thực hiện request từ thông tin mã máy bay để kiểm tra số tiền hoàn trả
2. Gửi POST tới API action URL để nhận về kết quả kiểm tra
3. 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. Request body

4.1 Ví dụ Request body

{
  "pnr_number": "F2S0LF",
  "guest_details": [
    {
      "given_name": "NAM",
      "sur_name": "KHANH",
      "name_prefix": "MR",
      "type": "ADULT",
      "guest_id": 2,
      "ticket_detail": {
        "number": "9262414264917"
      },
      "ticket_details": [
        {
          "number": "9262414264917",
          "coupon_details": [
            {
              "number": "1",
              "status": "I",
              "baggage_allowance_weight": "0",
              "baggage_allowance_unit": "K",
              "segment_id": 1
            }
          ]
        }
      ]
    }
  ],
  "air_booking_id": "FLN202510270951211761533481090752330"
}

4.2 Cấu trúc dữ liệu

Thuộc tính	Kiểu dữ liệu	Mô tả	Ví dụ
'Pnr_number'	string	Số PNR
'Guest_detail'	List	Chi tiết hành khách
'Given_name'	string	Tên
'Sur_name'	String	Họ
'Name_prefix'	String	Danh xưng
'type'	String	Loại hành khách
'Guest_id'	Number	ID hành khách
'Date_of_birth'	String	Ngày sinh
'Ticket_detail'	List	Chi tiết vé
'Number'	String	Số vé
'Air_booking_id'	String	ID booking hàng không

5. Response

5.1 Ví dụ Response

{
  "statusCode": 200,
  "timestamp": "2025-10-27T02:52:52.242Z",
  "path": "/api/v1/bamboo/manager/refund-amount",
  "message": "Kiểm tra số tiền hoàn PNR Bamboo Airways thành công",
  "data": {
    "success": true,
    "id": "FLN202510270951211761533481090752330",
    "message": [
      {
        "message": "Thành công!"
      }
    ],
    "data": {
      "error": null,
      "refund_amount": {
        "currency": "VND",
        "amount": 3356000,
        "tax_amount": 1418000,
        "cancel_fee_amount": 900000,
        "guest_amount": [
          {
            "guest_id": 2,
            "guest_type": "ADULT",
            "currency": "VND",
            "amount": 1678000,
            "tax_amount": 709000,
            "cancel_fee_amount": 450000
          },
          {
            "guest_id": 2,
            "guest_type": "ADULT",
            "currency": "VND",
            "amount": 1678000,
            "tax_amount": 709000,
            "cancel_fee_amount": 450000
          }
        ]
      }
    },
    "errors": null
  }
}

5.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ó.

5.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 Bamboo.
'message'	array<object>	Danh sách thông điệp chi tiết.
'data'	object	Dữ liệu kết quả kiểm tra số tiền hoàn.

5.4 data.data

Thuộc tính	Kiểu dữ liệu	Mô tả	Ví dụ
'error'	string \| null	Lỗi nếu có.
'refund_amount'	object	Thông tin tổng số tiền hoàn và chi tiết theo khách.

5.5 data.data.refund_amount

Thuộc tính	Kiểu dữ liệu	Mô tả	Ví dụ
'currency'	string (ISO-4217)	Tiền tệ hoàn.
'amount'	number	Tổng số tiền hoàn.
'tax_amount'	number	Tổng thuế hoàn.
'cancel_fee_amount'	number	Phí hủy/penalty.
'guest_amount'	array<object>	Chi tiết hoàn theo từng khách.

5.6 data.data.refund_amount.guest_amount[]

Thuộc tính	Kiểu dữ liệu	Mô tả	Ví dụ
'guest_id'	number (integer)	ID khách.
'guest_type'	string (enum)	Loại khách.
'currency'	string (ISO-4217)	Tiền tệ hoàn.
'amount'	number	Tổng tiền hoàn cho khách.
'tax_amount'	number	Thuế hoàn của khách.
'cancel_fee_amount'	number	Phí hủy áp cho khách.

---