Interface CheckoutPaymentRefundedEvent
- All Superinterfaces:
Event
Generated when a payment is successfully refunded in Checkout. This event confirms that the refund has been processed and sent to your customer.
Example to create an instance using the builder pattern
CheckoutPaymentRefundedEvent checkoutPaymentRefundedEvent = CheckoutPaymentRefundedEvent.builder()
.id("{id}")
.notificationType("{notificationType}")
.resourceType(EventSubscriptionResourceTypeId.CHECKOUT)
.createdAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
.data(dataBuilder -> dataBuilder)
.build()
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
discriminator value for CheckoutPaymentRefundedEvent -
Method Summary
Modifier and TypeMethodDescriptionbuilder()
builder factory method for CheckoutPaymentRefundedEventbuilder
(CheckoutPaymentRefundedEvent template) create builder for CheckoutPaymentRefundedEvent instancecopyDeep()
static CheckoutPaymentRefundedEvent
deepCopy
(CheckoutPaymentRefundedEvent template) factory method to create a deep copy of CheckoutPaymentRefundedEvent@NotNull @Valid CheckoutMessagePaymentsPayloadBaseData
getData()
An object containing details of the successful payment refund.@NotNull EventSubscriptionResourceTypeId
The type of resource targeted by the Event.static CheckoutPaymentRefundedEvent
of()
factory methodstatic CheckoutPaymentRefundedEvent
of
(CheckoutPaymentRefundedEvent template) factory method to create a shallow copy CheckoutPaymentRefundedEventvoid
An object containing details of the successful payment refund.void
setResourceType
(EventSubscriptionResourceTypeId resourceType) set resourceTypestatic com.fasterxml.jackson.core.type.TypeReference<CheckoutPaymentRefundedEvent>
gives a TypeReference for usage with Jackson DataBinddefault <T> T
accessor map functionMethods inherited from interface com.commercetools.api.models.event.Event
getCreatedAt, getId, getNotificationType, getType, setCreatedAt, setId, setNotificationType, withEvent
-
Field Details
-
CHECKOUT_PAYMENT_REFUNDED
discriminator value for CheckoutPaymentRefundedEvent- See Also:
-
-
Method Details
-
getResourceType
Description copied from interface:Event
The type of resource targeted by the Event.
- Specified by:
getResourceType
in interfaceEvent
- Returns:
- resourceType
-
getData
An object containing details of the successful payment refund.
- Returns:
- data
-
setResourceType
set resourceType- Specified by:
setResourceType
in interfaceEvent
- Parameters:
resourceType
- value to be set
-
setData
An object containing details of the successful payment refund.
- Parameters:
data
- value to be set
-
of
factory method- Returns:
- instance of CheckoutPaymentRefundedEvent
-
of
factory method to create a shallow copy CheckoutPaymentRefundedEvent- Parameters:
template
- instance to be copied- Returns:
- copy instance
-
copyDeep
CheckoutPaymentRefundedEvent copyDeep() -
deepCopy
@Nullable static CheckoutPaymentRefundedEvent deepCopy(@Nullable CheckoutPaymentRefundedEvent template) factory method to create a deep copy of CheckoutPaymentRefundedEvent- Parameters:
template
- instance to be copied- Returns:
- copy instance
-
builder
builder factory method for CheckoutPaymentRefundedEvent- Returns:
- builder
-
builder
create builder for CheckoutPaymentRefundedEvent instance- Parameters:
template
- instance with prefilled values for the builder- Returns:
- builder
-
withCheckoutPaymentRefundedEvent
accessor map function- Type Parameters:
T
- mapped type- Parameters:
helper
- function to map the object- Returns:
- mapped value
-
typeReference
gives a TypeReference for usage with Jackson DataBind- Returns:
- TypeReference
-