Interface CheckoutPaymentAuthorizedEvent
- All Superinterfaces:
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
FieldsModifier and TypeFieldDescriptionstatic final String
discriminator value for CheckoutPaymentAuthorizedEvent -
Method Summary
Modifier and TypeMethodDescriptionbuilder()
builder factory method for CheckoutPaymentAuthorizedEventbuilder
(CheckoutPaymentAuthorizedEvent template) create builder for CheckoutPaymentAuthorizedEvent instancecopyDeep()
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
The type of resource targeted by the Event.of()
factory methodof
(CheckoutPaymentAuthorizedEvent template) factory method to create a shallow copy CheckoutPaymentAuthorizedEventvoid
An object containing details of the successful payment authorization.void
setResourceType
(EventSubscriptionResourceTypeId resourceType) set resourceTypestatic com.fasterxml.jackson.core.type.TypeReference<CheckoutPaymentAuthorizedEvent>
gives a TypeReference for usage with Jackson DataBinddefault <T> T
accessor map functionMethods inherited from interface com.commercetools.api.models.event.Event
getCreatedAt, getId, getNotificationType, getType, setCreatedAt, setId, setNotificationType, withEvent
-
Field Details
-
CHECKOUT_PAYMENT_AUTHORIZED
discriminator value for CheckoutPaymentAuthorizedEvent- See Also:
-
-
Method Details
-
getResourceType
Description copied from interface:Event
The type of resource targeted by the Event.
- Specified by:
getResourceType
in interfaceEvent
- Returns:
- resourceType
-
getData
An object containing details of the successful payment authorization.
- Returns:
- data
-
setResourceType
set resourceType- Specified by:
setResourceType
in interfaceEvent
- Parameters:
resourceType
- value to be set
-
setData
An object containing details of the successful payment authorization.
- Parameters:
data
- value to be set
-
of
factory method- Returns:
- instance of CheckoutPaymentAuthorizedEvent
-
of
factory method to create a shallow copy CheckoutPaymentAuthorizedEvent- Parameters:
template
- instance to be copied- Returns:
- copy instance
-
copyDeep
CheckoutPaymentAuthorizedEvent copyDeep() -
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
builder factory method for CheckoutPaymentAuthorizedEvent- Returns:
- builder
-
builder
create builder for CheckoutPaymentAuthorizedEvent instance- Parameters:
template
- instance with prefilled values for the builder- Returns:
- builder
-
withCheckoutPaymentAuthorizedEvent
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
-