TravelCaster API - Fulfillment - PreviewRefund

Back to Fulfillment home.

---

Returns refund estimates for all tickets in the booking. No changes are made to the booking or any tickets.

Use this operation to retrieve and display the expected refund amounts per ticket before asking the user to confirm the refund.

Request

JSON

https://endpoint/api/version/FulfillmentService.json/PreviewRefund [POST]

request: RefundPreviewRequest

response: RefundPreviewResponse

Structure of the RefundPreviewRequest object

RefundPreviewRequest
 |
 |_ Token (string - required - access token from AuthService)
 |_ BookingNumber (string - required - record locator of the booking to refund)

Structure of the RefundPreviewResponse object

RefundPreviewResponse
 |
 |_ TransactionID (string)
 |_ TransactionCode (string - "0" = success)
 |_ TransactionMessage (string)
 |
 |_ BookingNumber (string - record locator)
 |_ RefundAvailable (bool? - true if at least one ticket has a refundable amount)
 |_ TicketDetails (RefundTicketDetail[] - one entry per ticket in the booking)
    |
    |_ DocumentNumber (string - ticket or EMD document number)
    |_ DocumentType (string - e.g. TKT, EMD)
    |_ PassengerName (string - full name)
    |_ PassengerType (string - ADT, CHD, INF)
    |_ Message (string - informational or eligibility message from the provider)
    |_ Guaranteed (bool? - true if the refund amount is guaranteed by the provider)
    |_ Refunded (bool? - true if the ticket has already been refunded)
    |_ TicketAmount (AmountData - original ticket total)
    |  |_ Amount (decimal)
    |  |_ Currency (string - ISO 3-letter)
    |_ TotalRefundableAmount (AmountData - total amount refundable for this ticket)
    |  |_ Amount (decimal)
    |  |_ Currency (string - ISO 3-letter)
    |_ EquivTotalRefundableAmount (AmountData - refundable amount in purchase currency)
    |  |_ Amount (decimal)
    |  |_ Currency (string - ISO 3-letter)
    |_ RefundFeeAmount (AmountData - penalty or cancellation fee)
    |  |_ Amount (decimal)
    |  |_ Currency (string - ISO 3-letter)
    |_ FareRefundableAmount (RefundableAmount - fare component breakdown)
    |  |_ Amount (decimal)
    |  |_ Currency (string - ISO 3-letter)
    |  |_ Description (string)
    |  |_ RefundableValue (decimal - portion that can be refunded)
    |  |_ NonRefundableValue (decimal - non-refundable portion)
    |  |_ UsedValue (decimal - portion already consumed)
    |_ TaxRefundableAmount (RefundableAmount - tax component breakdown)
    |  |_ (same structure as FareRefundableAmount)
    |_ FormsOfPayment (RefundPayment[] - original payment methods for this ticket)
       |
       |_ FormOfPayment (string - e.g. CASH, CC)
       |_ Amount (AmountData)
          |_ Amount (decimal)
          |_ Currency (string - ISO 3-letter)

Notes

• Preview results are estimates only. The actual refunded amount is confirmed upon FulfillRefund.
• Tickets where Refunded = true are already refunded and will not be processed again.
• RefundAvailable = false means no tickets are eligible for refund. Calling FulfillRefund in this state will result in an error from the provider.

---

Back to Fulfillment home.