Package com.commercetools.api.models.event

Interface CheckoutMessagePaymentsPayloadBaseData

public interface CheckoutMessagePaymentsPayloadBaseData

The data payload of all payment related event messages.

Example to create an instance using the builder pattern

     CheckoutMessagePaymentsPayloadBaseData checkoutMessagePaymentsPayloadBaseData = CheckoutMessagePaymentsPayloadBaseData.builder()
             .projectKey("{projectKey}")
             .payment(paymentBuilder -> paymentBuilder)
             .transactionId("{transactionId}")
             .build()
 

Method Summary

Modifier and Type	Method	Description
static CheckoutMessagePaymentsPayloadBaseDataBuilder	builder()	builder factory method for CheckoutMessagePaymentsPayloadBaseData
static CheckoutMessagePaymentsPayloadBaseDataBuilder	builder(CheckoutMessagePaymentsPayloadBaseData template)	create builder for CheckoutMessagePaymentsPayloadBaseData instance
CheckoutMessagePaymentsPayloadBaseData	copyDeep()
static CheckoutMessagePaymentsPayloadBaseData	deepCopy(CheckoutMessagePaymentsPayloadBaseData template)	factory method to create a deep copy of CheckoutMessagePaymentsPayloadBaseData
@Valid CartReference	getCart()	The Cart on which the change or action was performed.
@Valid OrderReference	getOrder()	The Order on which the change or action was performed.
@NotNull @Valid PaymentReference	getPayment()	The Payment on which the change or action was performed.
@NotNull String	getProjectKey()	key of the Project where the payment was made.
@NotNull String	getTransactionId()	id of the Transaction.
static CheckoutMessagePaymentsPayloadBaseData	of()	factory method
static CheckoutMessagePaymentsPayloadBaseData	of(CheckoutMessagePaymentsPayloadBaseData template)	factory method to create a shallow copy CheckoutMessagePaymentsPayloadBaseData
void	setCart(CartReference cart)	The Cart on which the change or action was performed.
void	setOrder(OrderReference order)	The Order on which the change or action was performed.
void	setPayment(PaymentReference payment)	The Payment on which the change or action was performed.
void	setProjectKey(String projectKey)	key of the Project where the payment was made.
void	setTransactionId(String transactionId)	id of the Transaction.
static com.fasterxml.jackson.core.type.TypeReference<CheckoutMessagePaymentsPayloadBaseData>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withCheckoutMessagePaymentsPayloadBaseData(Function<CheckoutMessagePaymentsPayloadBaseData,T> helper)	accessor map function

Method Details

getProjectKey

@NotNull
@NotNull String getProjectKey()

key of the Project where the payment was made.

Returns:

projectKey

getPayment

@NotNull
@Valid
@NotNull @Valid PaymentReference getPayment()

The Payment on which the change or action was performed.

Returns:

payment

getTransactionId

@NotNull
@NotNull String getTransactionId()

id of the Transaction.

Returns:

transactionId

getCart

@Valid
@Valid CartReference getCart()

The Cart on which the change or action was performed.

Returns:

cart

getOrder

@Valid
@Valid OrderReference getOrder()

The Order on which the change or action was performed.

Returns:

order

setProjectKey

void setProjectKey(String projectKey)

key of the Project where the payment was made.

Parameters:

projectKey - value to be set

setPayment

void setPayment(PaymentReference payment)

The Payment on which the change or action was performed.

Parameters:

payment - value to be set

setTransactionId

void setTransactionId(String transactionId)

id of the Transaction.

Parameters:

transactionId - value to be set

setCart

void setCart(CartReference cart)

The Cart on which the change or action was performed.

Parameters:

cart - value to be set

setOrder

void setOrder(OrderReference order)

The Order on which the change or action was performed.

Parameters:

order - value to be set

of

static CheckoutMessagePaymentsPayloadBaseData of()

factory method

Returns:

instance of CheckoutMessagePaymentsPayloadBaseData

of

static CheckoutMessagePaymentsPayloadBaseData of(CheckoutMessagePaymentsPayloadBaseData template)

factory method to create a shallow copy CheckoutMessagePaymentsPayloadBaseData

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

CheckoutMessagePaymentsPayloadBaseData copyDeep()

deepCopy

@Nullable
static CheckoutMessagePaymentsPayloadBaseData deepCopy(@Nullable
 CheckoutMessagePaymentsPayloadBaseData template)

factory method to create a deep copy of CheckoutMessagePaymentsPayloadBaseData

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static CheckoutMessagePaymentsPayloadBaseDataBuilder builder()

builder factory method for CheckoutMessagePaymentsPayloadBaseData

Returns:

builder

builder

static CheckoutMessagePaymentsPayloadBaseDataBuilder builder(CheckoutMessagePaymentsPayloadBaseData template)

create builder for CheckoutMessagePaymentsPayloadBaseData instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withCheckoutMessagePaymentsPayloadBaseData

default <T> T withCheckoutMessagePaymentsPayloadBaseData(Function<CheckoutMessagePaymentsPayloadBaseData,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<CheckoutMessagePaymentsPayloadBaseData> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference