Package com.commercetools.api.models.event

Interface CheckoutPaymentChargeFailedEvent

All Superinterfaces:

Event

public interface CheckoutPaymentChargeFailedEvent
extends Event

Generated when an attempt to charge a payment fails in Checkout. Even if a payment was previously authorized, charging it may still fail.

Example to create an instance using the builder pattern

     CheckoutPaymentChargeFailedEvent checkoutPaymentChargeFailedEvent = CheckoutPaymentChargeFailedEvent.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_CHARGE_FAILED	discriminator value for CheckoutPaymentChargeFailedEvent

Method Summary

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

static final String CHECKOUT_PAYMENT_CHARGE_FAILED

discriminator value for CheckoutPaymentChargeFailedEvent

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

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

Parameters:

data - value to be set

of

static CheckoutPaymentChargeFailedEvent of()

factory method

Returns:

instance of CheckoutPaymentChargeFailedEvent

of

static CheckoutPaymentChargeFailedEvent of(CheckoutPaymentChargeFailedEvent template)

factory method to create a shallow copy CheckoutPaymentChargeFailedEvent

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

CheckoutPaymentChargeFailedEvent copyDeep()

Specified by:

copyDeep in interface Event

deepCopy

@Nullable
static CheckoutPaymentChargeFailedEvent deepCopy(@Nullable
 CheckoutPaymentChargeFailedEvent template)

factory method to create a deep copy of CheckoutPaymentChargeFailedEvent

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static CheckoutPaymentChargeFailedEventBuilder builder()

builder factory method for CheckoutPaymentChargeFailedEvent

Returns:

builder

builder

static CheckoutPaymentChargeFailedEventBuilder builder(CheckoutPaymentChargeFailedEvent template)

create builder for CheckoutPaymentChargeFailedEvent instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withCheckoutPaymentChargeFailedEvent

default <T> T withCheckoutPaymentChargeFailedEvent(Function<CheckoutPaymentChargeFailedEvent,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<CheckoutPaymentChargeFailedEvent> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference