Package com.commercetools.api.models.event

Interface CheckoutPaymentAuthorizationCancelledEvent

All Superinterfaces:

Event

public interface CheckoutPaymentAuthorizationCancelledEvent
extends Event

Generated when a payment authorization is successfully cancelled in Checkout. This event indicates that the payment is cancelled before it is charged.

Example to create an instance using the builder pattern

     CheckoutPaymentAuthorizationCancelledEvent checkoutPaymentAuthorizationCancelledEvent = CheckoutPaymentAuthorizationCancelledEvent.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_AUTHORIZATION_CANCELLED	discriminator value for CheckoutPaymentAuthorizationCancelledEvent

Method Summary

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

static final String CHECKOUT_PAYMENT_AUTHORIZATION_CANCELLED

discriminator value for CheckoutPaymentAuthorizationCancelledEvent

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 was 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 was cancelled.

Parameters:

data - value to be set

of

static CheckoutPaymentAuthorizationCancelledEvent of()

factory method

Returns:

instance of CheckoutPaymentAuthorizationCancelledEvent

of

static CheckoutPaymentAuthorizationCancelledEvent of(CheckoutPaymentAuthorizationCancelledEvent template)

factory method to create a shallow copy CheckoutPaymentAuthorizationCancelledEvent

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

CheckoutPaymentAuthorizationCancelledEvent copyDeep()

Specified by:

copyDeep in interface Event

deepCopy

@Nullable
static CheckoutPaymentAuthorizationCancelledEvent deepCopy(@Nullable
 CheckoutPaymentAuthorizationCancelledEvent template)

factory method to create a deep copy of CheckoutPaymentAuthorizationCancelledEvent

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static CheckoutPaymentAuthorizationCancelledEventBuilder builder()

builder factory method for CheckoutPaymentAuthorizationCancelledEvent

Returns:

builder

builder

static CheckoutPaymentAuthorizationCancelledEventBuilder builder(CheckoutPaymentAuthorizationCancelledEvent template)

create builder for CheckoutPaymentAuthorizationCancelledEvent instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withCheckoutPaymentAuthorizationCancelledEvent

default <T> T withCheckoutPaymentAuthorizationCancelledEvent(Function<CheckoutPaymentAuthorizationCancelledEvent,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<CheckoutPaymentAuthorizationCancelledEvent> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference