Package com.commercetools.api.models.payment

Interface PaymentAddTransactionAction

All Superinterfaces:

PaymentUpdateAction, ResourceUpdateAction<PaymentUpdateAction>

All Known Implementing Classes:

PaymentAddTransactionActionImpl

public interface PaymentAddTransactionAction
extends PaymentUpdateAction

Adding a Transaction to a Payment generates the PaymentTransactionAdded Message.

Example to create an instance using the builder pattern

     PaymentAddTransactionAction paymentAddTransactionAction = PaymentAddTransactionAction.builder()
             .transaction(transactionBuilder -> transactionBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADD_TRANSACTION	discriminator value for PaymentAddTransactionAction

Method Summary

Modifier and Type	Method	Description
static PaymentAddTransactionActionBuilder	builder()	builder factory method for PaymentAddTransactionAction
static PaymentAddTransactionActionBuilder	builder(PaymentAddTransactionAction template)	create builder for PaymentAddTransactionAction instance
static PaymentAddTransactionAction	deepCopy(PaymentAddTransactionAction template)	factory method to create a deep copy of PaymentAddTransactionAction
@NotNull @Valid TransactionDraft	getTransaction()	Value to append to the transactions array.
static PaymentAddTransactionAction	of()	factory method
static PaymentAddTransactionAction	of(PaymentAddTransactionAction template)	factory method to create a shallow copy PaymentAddTransactionAction
void	setTransaction(TransactionDraft transaction)	Value to append to the transactions array.
static com.fasterxml.jackson.core.type.TypeReference<PaymentAddTransactionAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withPaymentAddTransactionAction(Function<PaymentAddTransactionAction,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.payment.PaymentUpdateAction

getAction, withPaymentUpdateAction

Methods inherited from interface com.commercetools.api.models.ResourceUpdateAction

get

Field Details

ADD_TRANSACTION

static final String ADD_TRANSACTION

discriminator value for PaymentAddTransactionAction

See Also:

• Constant Field Values

Method Details

getTransaction

@NotNull
@Valid
@NotNull @Valid TransactionDraft getTransaction()

Value to append to the transactions array.

Returns:

transaction

setTransaction

void setTransaction(TransactionDraft transaction)

Value to append to the transactions array.

Parameters:

transaction - value to be set

of

static PaymentAddTransactionAction of()

factory method

Returns:

instance of PaymentAddTransactionAction

of

static PaymentAddTransactionAction of(PaymentAddTransactionAction template)

factory method to create a shallow copy PaymentAddTransactionAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static PaymentAddTransactionAction deepCopy(@Nullable
 PaymentAddTransactionAction template)

factory method to create a deep copy of PaymentAddTransactionAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static PaymentAddTransactionActionBuilder builder()

builder factory method for PaymentAddTransactionAction

Returns:

builder

builder

static PaymentAddTransactionActionBuilder builder(PaymentAddTransactionAction template)

create builder for PaymentAddTransactionAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withPaymentAddTransactionAction

default <T> T withPaymentAddTransactionAction(Function<PaymentAddTransactionAction,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<PaymentAddTransactionAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference