Package com.commercetools.api.models.event

Interface CheckoutPaymentAuthorizationFailedEvent

All Superinterfaces:

Event

public interface CheckoutPaymentAuthorizationFailedEvent
extends Event

Generated when an attempt to authorize a payment fails in Checkout. This failure could result from insufficient funds, incorrect payment details, expired cards, or risk related rejections.

Example to create an instance using the builder pattern

     CheckoutPaymentAuthorizationFailedEvent checkoutPaymentAuthorizationFailedEvent = CheckoutPaymentAuthorizationFailedEvent.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_FAILED	discriminator value for CheckoutPaymentAuthorizationFailedEvent

Method Summary

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

static final String CHECKOUT_PAYMENT_AUTHORIZATION_FAILED

discriminator value for CheckoutPaymentAuthorizationFailedEvent

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 failed.

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 failed.

Parameters:

data - value to be set

of

static CheckoutPaymentAuthorizationFailedEvent of()

factory method

Returns:

instance of CheckoutPaymentAuthorizationFailedEvent

of

static CheckoutPaymentAuthorizationFailedEvent of(CheckoutPaymentAuthorizationFailedEvent template)

factory method to create a shallow copy CheckoutPaymentAuthorizationFailedEvent

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

CheckoutPaymentAuthorizationFailedEvent copyDeep()

Specified by:

copyDeep in interface Event

deepCopy

@Nullable
static CheckoutPaymentAuthorizationFailedEvent deepCopy(@Nullable
 CheckoutPaymentAuthorizationFailedEvent template)

factory method to create a deep copy of CheckoutPaymentAuthorizationFailedEvent

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static CheckoutPaymentAuthorizationFailedEventBuilder builder()

builder factory method for CheckoutPaymentAuthorizationFailedEvent

Returns:

builder

builder

static CheckoutPaymentAuthorizationFailedEventBuilder builder(CheckoutPaymentAuthorizationFailedEvent template)

create builder for CheckoutPaymentAuthorizationFailedEvent instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withCheckoutPaymentAuthorizationFailedEvent

default <T> T withCheckoutPaymentAuthorizationFailedEvent(Function<CheckoutPaymentAuthorizationFailedEvent,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<CheckoutPaymentAuthorizationFailedEvent> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference