Package com.commercetools.api.models.event

Interface CheckoutPaymentAuthorizedEvent

All Superinterfaces:

Event

public interface CheckoutPaymentAuthorizedEvent
extends Event

Generated when a payment is successfully authorized in Checkout. This event indicates the payment has been validated and the amount has been reserved but not yet charged.

Example to create an instance using the builder pattern

     CheckoutPaymentAuthorizedEvent checkoutPaymentAuthorizedEvent = CheckoutPaymentAuthorizedEvent.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_AUTHORIZED	discriminator value for CheckoutPaymentAuthorizedEvent

Method Summary

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

static final String CHECKOUT_PAYMENT_AUTHORIZED

discriminator value for CheckoutPaymentAuthorizedEvent

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 successful payment authorization.

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 successful payment authorization.

Parameters:

data - value to be set

of

static CheckoutPaymentAuthorizedEvent of()

factory method

Returns:

instance of CheckoutPaymentAuthorizedEvent

of

static CheckoutPaymentAuthorizedEvent of(CheckoutPaymentAuthorizedEvent template)

factory method to create a shallow copy CheckoutPaymentAuthorizedEvent

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

CheckoutPaymentAuthorizedEvent copyDeep()

Specified by:

copyDeep in interface Event

deepCopy

@Nullable
static CheckoutPaymentAuthorizedEvent deepCopy(@Nullable
 CheckoutPaymentAuthorizedEvent template)

factory method to create a deep copy of CheckoutPaymentAuthorizedEvent

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static CheckoutPaymentAuthorizedEventBuilder builder()

builder factory method for CheckoutPaymentAuthorizedEvent

Returns:

builder

builder

static CheckoutPaymentAuthorizedEventBuilder builder(CheckoutPaymentAuthorizedEvent template)

create builder for CheckoutPaymentAuthorizedEvent instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withCheckoutPaymentAuthorizedEvent

default <T> T withCheckoutPaymentAuthorizedEvent(Function<CheckoutPaymentAuthorizedEvent,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<CheckoutPaymentAuthorizedEvent> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference