Package com.commercetools.api.models.event

Interface CheckoutPaymentChargedEvent

All Superinterfaces:

Event

public interface CheckoutPaymentChargedEvent
extends Event

Generated when a payment is successfully charged in Checkout. This event indicates that the authorized amount has been successfully debited from your customer's account.

Example to create an instance using the builder pattern

     CheckoutPaymentChargedEvent checkoutPaymentChargedEvent = CheckoutPaymentChargedEvent.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_CHARGED	discriminator value for CheckoutPaymentChargedEvent

Method Summary

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

static final String CHECKOUT_PAYMENT_CHARGED

discriminator value for CheckoutPaymentChargedEvent

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

Parameters:

data - value to be set

of

static CheckoutPaymentChargedEvent of()

factory method

Returns:

instance of CheckoutPaymentChargedEvent

of

static CheckoutPaymentChargedEvent of(CheckoutPaymentChargedEvent template)

factory method to create a shallow copy CheckoutPaymentChargedEvent

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

CheckoutPaymentChargedEvent copyDeep()

Specified by:

copyDeep in interface Event

deepCopy

@Nullable
static CheckoutPaymentChargedEvent deepCopy(@Nullable
 CheckoutPaymentChargedEvent template)

factory method to create a deep copy of CheckoutPaymentChargedEvent

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static CheckoutPaymentChargedEventBuilder builder()

builder factory method for CheckoutPaymentChargedEvent

Returns:

builder

builder

static CheckoutPaymentChargedEventBuilder builder(CheckoutPaymentChargedEvent template)

create builder for CheckoutPaymentChargedEvent instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withCheckoutPaymentChargedEvent

default <T> T withCheckoutPaymentChargedEvent(Function<CheckoutPaymentChargedEvent,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<CheckoutPaymentChargedEvent> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference