Package com.commercetools.api.models.event

Interface CheckoutPaymentCancelAuthorizationFailedEvent

All Superinterfaces:

Event

public interface CheckoutPaymentCancelAuthorizationFailedEvent
extends Event

Generated when an attempt to cancel a payment authorization fails in Checkout. This could happen if the authorization has already been expired, been captured already or no longer valid.

Example to create an instance using the builder pattern

     CheckoutPaymentCancelAuthorizationFailedEvent checkoutPaymentCancelAuthorizationFailedEvent = CheckoutPaymentCancelAuthorizationFailedEvent.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_CANCEL_AUTHORIZATION_FAILED	discriminator value for CheckoutPaymentCancelAuthorizationFailedEvent

Method Summary

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

static final String CHECKOUT_PAYMENT_CANCEL_AUTHORIZATION_FAILED

discriminator value for CheckoutPaymentCancelAuthorizationFailedEvent

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 payment authorization that could not be cancelled.

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 payment authorization that could not be cancelled.

Parameters:

data - value to be set

of

static CheckoutPaymentCancelAuthorizationFailedEvent of()

factory method

Returns:

instance of CheckoutPaymentCancelAuthorizationFailedEvent

of

static CheckoutPaymentCancelAuthorizationFailedEvent of(CheckoutPaymentCancelAuthorizationFailedEvent template)

factory method to create a shallow copy CheckoutPaymentCancelAuthorizationFailedEvent

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

CheckoutPaymentCancelAuthorizationFailedEvent copyDeep()

Specified by:

copyDeep in interface Event

deepCopy

@Nullable
static CheckoutPaymentCancelAuthorizationFailedEvent deepCopy(@Nullable
 CheckoutPaymentCancelAuthorizationFailedEvent template)

factory method to create a deep copy of CheckoutPaymentCancelAuthorizationFailedEvent

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static CheckoutPaymentCancelAuthorizationFailedEventBuilder builder()

builder factory method for CheckoutPaymentCancelAuthorizationFailedEvent

Returns:

builder

builder

static CheckoutPaymentCancelAuthorizationFailedEventBuilder builder(CheckoutPaymentCancelAuthorizationFailedEvent template)

create builder for CheckoutPaymentCancelAuthorizationFailedEvent instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withCheckoutPaymentCancelAuthorizationFailedEvent

default <T> T withCheckoutPaymentCancelAuthorizationFailedEvent(Function<CheckoutPaymentCancelAuthorizationFailedEvent,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<CheckoutPaymentCancelAuthorizationFailedEvent> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference