[AirHost API] Reservation, Pricing, and Payment Response Samples

The AirHost API (Internal System API) provides reservation information, including the reservation source, charge and tax breakdowns, payment status, and payment/refund history.

The following response samples are based on actual reservation data, with personal information and information that could identify the reservation anonymized and modified.

`GET /stays/{id}`

GET /stays/{id} provides reservation details, reservation source, charge and tax breakdowns, payment status, and other related information.

The following are some of the main fields available:

Content	API field
Reservation source / channel	`reservation_source_code` / `reservation_source_name`
Accommodation fee	`accommodation_fee`
Cleaning fee	`cleaning_fee`
OTA commission	`channel_fee`
Cancellation fee	`cancellation_fee`
Charge and tax breakdown	`fee_breakdown`
OTA prepaid amount	`prepaid_amount`
Total charge amount	`total_charge_amount`
Total payment amount	`total_payment_amount`
Outstanding balance	`outstanding_balance`

Response Example

The following is an example of a Booking.com reservation.

{
  "reservation_source_name": "Booking.com",
  "accommodation_fee": 64800.0,
  "channel_fee": 9266.0,
  "prepaid_amount": 64800.0,
  "total_charge_amount": 66600.0,
  "total_payment_amount": 64800.0,
  "outstanding_balance": 1800.0,
  "fee_breakdown": [
    {
      "type": "per_day",
      "name": "Standard Rate",
      "amount": 64800.0
    },
    {
      "type": "channel_fee",
      "name": "OTA commission and payment processing fee",
      "amount": 9266.0
    },
    {
      "type": "other_fee",
      "name": "Municipal tax",
      "amount": 1800.0
    }
  ]
}

In this example, the accommodation charge of JPY 64,800 was collected by the OTA. Since the total charge amount is JPY 66,600 and JPY 64,800 has been paid, the outstanding balance is JPY 1,800.

`GET /folios/{id}`

GET /folios/{id} provides individual charges associated with the reservation, as well as payment and refund history.

The following are some of the main fields available:

Content	API field
Individual charges	`charges`
Payment/refund history	`payments`
Payment amount	`amount`
Refund amount	`refund_amount`
Payment status	`state`
Payment date	`date`
Total charge amount	`total_charge_amount`
Total payment amount	`total_payment_amount`
Outstanding balance	`outstanding_balance`

Payment and Refund History Example

{
  "payments": [
    {
      "payment_source_type": "ota_collect",
      "amount": 64800.0,
      "refund_amount": 0.0,
      "state": "completed",
      "date": "2026-06-20"
    }
  ],
  "total_charge_amount": 66600.0,
  "total_payment_amount": 64800.0,
  "outstanding_balance": 1800.0
}

About `partial_paid` / `over_paid`

The API does not provide dedicated status fields such as partial_paid or over_paid.

The payment status can be determined by comparing total_payment_amount with total_charge_amount.

total_payment_amount < total_charge_amount
→ Partially unpaid

total_payment_amount = total_charge_amount
→ Fully paid

total_payment_amount > total_charge_amount
→ Overpaid

Individual charge details and payment/refund history can be checked using the charges and payments fields.

Note: The fields available and the contents of fee_breakdown may vary depending on the reservation source, payment method, property settings, and fees or taxes associated with the reservation.