Package com.commercetools.api.models.event

Interface CheckoutPaymentRefundFailedEvent

All Superinterfaces:

Event

public interface CheckoutPaymentRefundFailedEvent
extends Event

Generated when an attempt to refund a payment refund fails in Checkout. This failure indicates that the planned refund amount was not successfully sent to your customer’s account.

Example to create an instance using the builder pattern

     CheckoutPaymentRefundFailedEvent checkoutPaymentRefundFailedEvent = CheckoutPaymentRefundFailedEvent.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_REFUND_FAILED	discriminator value for CheckoutPaymentRefundFailedEvent

Method Summary

Modifier and Type	Method	Description
static CheckoutPaymentRefundFailedEventBuilder	builder()	builder factory method for CheckoutPaymentRefundFailedEvent
static CheckoutPaymentRefundFailedEventBuilder	builder(CheckoutPaymentRefundFailedEvent template)	create builder for CheckoutPaymentRefundFailedEvent instance
CheckoutPaymentRefundFailedEvent	copyDeep()
static CheckoutPaymentRefundFailedEvent	deepCopy(CheckoutPaymentRefundFailedEvent template)	factory method to create a deep copy of CheckoutPaymentRefundFailedEvent
@NotNull @Valid CheckoutMessagePaymentsPayloadBaseData	getData()	An object containing details of the failed payment refund attempt.
@NotNull EventSubscriptionResourceTypeId	getResourceType()	The type of resource targeted by the Event.
static CheckoutPaymentRefundFailedEvent	of()	factory method
static CheckoutPaymentRefundFailedEvent	of(CheckoutPaymentRefundFailedEvent template)	factory method to create a shallow copy CheckoutPaymentRefundFailedEvent
void	setData(CheckoutMessagePaymentsPayloadBaseData data)	An object containing details of the failed payment refund attempt.
void	setResourceType(EventSubscriptionResourceTypeId resourceType)	set resourceType
static com.fasterxml.jackson.core.type.TypeReference<CheckoutPaymentRefundFailedEvent>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withCheckoutPaymentRefundFailedEvent(Function<CheckoutPaymentRefundFailedEvent,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_REFUND_FAILED

static final String CHECKOUT_PAYMENT_REFUND_FAILED

discriminator value for CheckoutPaymentRefundFailedEvent

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 failed payment refund attempt.

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 failed payment refund attempt.

Parameters:

data - value to be set

of

static CheckoutPaymentRefundFailedEvent of()

factory method

Returns:

instance of CheckoutPaymentRefundFailedEvent

of

static CheckoutPaymentRefundFailedEvent of(CheckoutPaymentRefundFailedEvent template)

factory method to create a shallow copy CheckoutPaymentRefundFailedEvent

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

CheckoutPaymentRefundFailedEvent copyDeep()

Specified by:

copyDeep in interface Event

deepCopy

@Nullable
static CheckoutPaymentRefundFailedEvent deepCopy(@Nullable
 CheckoutPaymentRefundFailedEvent template)

factory method to create a deep copy of CheckoutPaymentRefundFailedEvent

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static CheckoutPaymentRefundFailedEventBuilder builder()

builder factory method for CheckoutPaymentRefundFailedEvent

Returns:

builder

builder

static CheckoutPaymentRefundFailedEventBuilder builder(CheckoutPaymentRefundFailedEvent template)

create builder for CheckoutPaymentRefundFailedEvent instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withCheckoutPaymentRefundFailedEvent

default <T> T withCheckoutPaymentRefundFailedEvent(Function<CheckoutPaymentRefundFailedEvent,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<CheckoutPaymentRefundFailedEvent> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference