Package com.commercetools.api.models.event

Interface CheckoutPaymentRefundedEvent

All Superinterfaces:

Event

public interface CheckoutPaymentRefundedEvent
extends 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

Fields

Modifier and Type	Field	Description
static final String	CHECKOUT_PAYMENT_REFUNDED	discriminator value for CheckoutPaymentRefundedEvent

Method Summary

Modifier and Type	Method	Description
static CheckoutPaymentRefundedEventBuilder	builder()	builder factory method for CheckoutPaymentRefundedEvent
static CheckoutPaymentRefundedEventBuilder	builder(CheckoutPaymentRefundedEvent template)	create builder for CheckoutPaymentRefundedEvent instance
CheckoutPaymentRefundedEvent	copyDeep()
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	getResourceType()	The type of resource targeted by the Event.
static CheckoutPaymentRefundedEvent	of()	factory method
static CheckoutPaymentRefundedEvent	of(CheckoutPaymentRefundedEvent template)	factory method to create a shallow copy CheckoutPaymentRefundedEvent
void	setData(CheckoutMessagePaymentsPayloadBaseData data)	An object containing details of the successful payment refund.
void	setResourceType(EventSubscriptionResourceTypeId resourceType)	set resourceType
static com.fasterxml.jackson.core.type.TypeReference<CheckoutPaymentRefundedEvent>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withCheckoutPaymentRefundedEvent(Function<CheckoutPaymentRefundedEvent,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.event.Event

getCreatedAt, getId, getNotificationType, getType, setCreatedAt, setId, setNotificationType, withEvent

Field Details

CHECKOUT_PAYMENT_REFUNDED

static final String CHECKOUT_PAYMENT_REFUNDED

discriminator value for CheckoutPaymentRefundedEvent

See Also:

• Constant Field Values

Method Details

getResourceType

@NotNull
@NotNull EventSubscriptionResourceTypeId getResourceType()

Description copied from interface: Event

The type of resource targeted by the Event.

Specified by:

getResourceType in interface Event

Returns:

resourceType

getData

@NotNull
@Valid
@NotNull @Valid CheckoutMessagePaymentsPayloadBaseData getData()

An object containing details of the successful payment refund.

Returns:

data

setResourceType

void setResourceType(EventSubscriptionResourceTypeId resourceType)

set resourceType

Specified by:

setResourceType in interface Event

Parameters:

resourceType - value to be set

setData

void setData(CheckoutMessagePaymentsPayloadBaseData data)

An object containing details of the successful payment refund.

Parameters:

data - value to be set

of

static CheckoutPaymentRefundedEvent of()

factory method

Returns:

instance of CheckoutPaymentRefundedEvent

of

static CheckoutPaymentRefundedEvent of(CheckoutPaymentRefundedEvent template)

factory method to create a shallow copy CheckoutPaymentRefundedEvent

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

CheckoutPaymentRefundedEvent copyDeep()

Specified by:

copyDeep in interface Event

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

static CheckoutPaymentRefundedEventBuilder builder()

builder factory method for CheckoutPaymentRefundedEvent

Returns:

builder

builder

static CheckoutPaymentRefundedEventBuilder builder(CheckoutPaymentRefundedEvent template)

create builder for CheckoutPaymentRefundedEvent instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withCheckoutPaymentRefundedEvent

default <T> T withCheckoutPaymentRefundedEvent(Function<CheckoutPaymentRefundedEvent,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

typeReference

static com.fasterxml.jackson.core.type.TypeReference<CheckoutPaymentRefundedEvent> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference