TravelCaster API - Fulfillment - FulfillRefund

Back to Fulfillment home.

---

Executes the refund for all refundable tickets in the booking. Returns the amounts refunded per ticket and per form of payment.

This operation is irreversible. Call PreviewRefund first to display the expected amounts to the user before confirming.

Request

JSON

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

request: RefundFulfillRequest

response: RefundFulfillResponse

Structure of the RefundFulfillRequest object

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

Structure of the RefundFulfillResponse object

RefundFulfillResponse
 |
 |_ TransactionID (string)
 |_ TransactionCode (string - "0" = success)
 |_ TransactionMessage (string - non-empty on success indicates a warning; see Notes)
 |
 |_ BookingNumber (string - record locator)
 |_ RefundSuccessful (bool - true if all tickets were successfully refunded)
 |_ TicketDetails (RefundTicketDetail[] - one entry per ticket processed)
 |  |
 |  |_ 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 message or per-ticket result from the provider)
 |  |_ Guaranteed (bool? - true if the refunded amount was guaranteed)
 |  |_ Refunded (bool? - true if this ticket was successfully refunded in this operation)
 |  |_ TicketAmount (AmountData - original ticket total)
 |  |  |_ Amount (decimal)
 |  |  |_ Currency (string - ISO 3-letter)
 |  |_ TotalRefundableAmount (AmountData - total refundable amount 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 applied)
 |  |  |_ Amount (decimal)
 |  |  |_ Currency (string - ISO 3-letter)
 |  |_ FareRefundableAmount (RefundableAmount - fare component breakdown)
 |  |  |_ Amount (decimal)
 |  |  |_ Currency (string - ISO 3-letter)
 |  |  |_ Description (string)
 |  |  |_ RefundableValue (decimal)
 |  |  |_ NonRefundableValue (decimal)
 |  |  |_ UsedValue (decimal)
 |  |_ TaxRefundableAmount (RefundableAmount - tax component breakdown)
 |  |  |_ (same structure as FareRefundableAmount)
 |  |_ FormsOfPayment (RefundPayment[] - payment breakdown for this ticket)
 |     |
 |     |_ FormOfPayment (string - e.g. CASH, CC)
 |     |_ Amount (AmountData)
 |        |_ Amount (decimal)
 |        |_ Currency (string - ISO 3-letter)
 |
 |_ RefundedAmounts (RefundPayment[] - aggregate refunded amounts across all tickets, by FOP)
    |
    |_ FormOfPayment (string - e.g. CASH, CC)
    |_ Amount (AmountData)
       |_ Amount (decimal)
       |_ Currency (string - ISO 3-letter)

Notes

• All refundable tickets in the booking are processed in a single call. Partial refunds (selected tickets only) are not supported.
• RefundSuccessful = true indicates all tickets were refunded. Individual ticket outcomes are available in TicketDetails[].Refunded.
• RefundedAmounts aggregates the total amounts returned per form of payment across all tickets, useful for displaying the summary to the user.
• A TransactionCode of "0" with a non-empty TransactionMessage means the refund was processed but the backoffice notification could not be delivered. The refund is confirmed; the warning is informational.

---

Back to Fulfillment home.