Package com.duffel.sdk.model
Class OrderCancellation
java.lang.Object
com.duffel.sdk.model.OrderCancellation
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
date="2024-01-16T15:26:22.356688490+07:00[Asia/Bangkok]")
public class OrderCancellation
extends Object
An order cancellation is used to cancel an order with an airline
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enumWhere the refund, once confirmed, will be sent. -
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionconfirmedAt(LocalDateTime confirmedAt) createdAt(LocalDateTime createdAt) booleanexpiresAt(LocalDateTime expiresAt) The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime that indicates when the order cancellation was confirmedThe [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime at which the order cancellation was createdThe [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime by which this cancellation must be confirmed@NotNull StringgetId()Duffel's unique identifier for the order cancellation@NotNull BooleanWhether the order cancellation was created in live mode.@NotNull StringDuffel's unique identifier for the order@NotNull StringThe amount that will be returned to the original payment method if the order is cancelled, determined according to the fare conditions.@NotNull StringThe currency of the `refund_amount`, as an [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.@NotNull OrderCancellation.RefundToEnumWhere the refund, once confirmed, will be sent.inthashCode()refundAmount(String refundAmount) refundCurrency(String refundCurrency) refundTo(OrderCancellation.RefundToEnum refundTo) voidsetConfirmedAt(LocalDateTime confirmedAt) voidsetCreatedAt(LocalDateTime createdAt) voidsetExpiresAt(LocalDateTime expiresAt) voidvoidsetLiveMode(Boolean liveMode) voidsetOrderId(String orderId) voidsetRefundAmount(String refundAmount) voidsetRefundCurrency(String refundCurrency) voidsetRefundTo(OrderCancellation.RefundToEnum refundTo) toString()
-
Field Details
-
JSON_PROPERTY_CONFIRMED_AT
- See Also:
-
JSON_PROPERTY_CREATED_AT
- See Also:
-
JSON_PROPERTY_EXPIRES_AT
- See Also:
-
JSON_PROPERTY_ID
- See Also:
-
JSON_PROPERTY_LIVE_MODE
- See Also:
-
JSON_PROPERTY_ORDER_ID
- See Also:
-
JSON_PROPERTY_REFUND_AMOUNT
- See Also:
-
JSON_PROPERTY_REFUND_CURRENCY
- See Also:
-
JSON_PROPERTY_REFUND_TO
- See Also:
-
-
Constructor Details
-
OrderCancellation
public OrderCancellation()
-
-
Method Details
-
confirmedAt
-
getConfirmedAt
The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime that indicates when the order cancellation was confirmed- Returns:
- confirmedAt
-
setConfirmedAt
-
createdAt
-
getCreatedAt
The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime at which the order cancellation was created- Returns:
- createdAt
-
setCreatedAt
-
expiresAt
-
getExpiresAt
The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime by which this cancellation must be confirmed- Returns:
- expiresAt
-
setExpiresAt
-
id
-
getId
Duffel's unique identifier for the order cancellation- Returns:
- id
-
setId
-
liveMode
-
getLiveMode
Whether the order cancellation was created in live mode. This field will be set to `true` if the order cancellation was created in live mode, or `false` if it was created in test mode.- Returns:
- liveMode
-
setLiveMode
-
orderId
-
getOrderId
Duffel's unique identifier for the order- Returns:
- orderId
-
setOrderId
-
refundAmount
-
getRefundAmount
The amount that will be returned to the original payment method if the order is cancelled, determined according to the fare conditions. This may be `0.00` if the fare is non-refundable. It will include the refund amount of the flights and the services booked.- Returns:
- refundAmount
-
setRefundAmount
-
refundCurrency
-
getRefundCurrency
The currency of the `refund_amount`, as an [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code. It will match your organisation's billing currency unless you’re using Duffel as an accredited IATA agent, in which case it will be in the currency provided by the airline (which will usually be based on the country where your IATA agency is registered). For `hold` orders that are awaiting payment, the refund amount will always be 0.00.- Returns:
- refundCurrency
-
setRefundCurrency
-
refundTo
-
getRefundTo
Where the refund, once confirmed, will be sent. `card` is currently a restricted feature. `awaiting_payment` is for pay later orders where no payment has been made yet.- Returns:
- refundTo
-
setRefundTo
-
equals
-
hashCode
public int hashCode() -
toString
-