Package com.commercetools.api.models.me

Interface MyPaymentAddTransactionAction

All Superinterfaces:

MyPaymentUpdateAction, ResourceUpdateAction<MyPaymentUpdateAction>

public interface MyPaymentAddTransactionAction
extends MyPaymentUpdateAction

Adding a Transaction to a Payment generates the PaymentTransactionAdded Message. Once a Transaction is added to the Payment, it can no longer be updated or deleted using the My Payments API.

Example to create an instance using the builder pattern

     MyPaymentAddTransactionAction myPaymentAddTransactionAction = MyPaymentAddTransactionAction.builder()
             .transaction(transactionBuilder -> transactionBuilder)
             .build()
 

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static MyPaymentAddTransactionActionBuilder	builder()	builder factory method for MyPaymentAddTransactionAction
static MyPaymentAddTransactionActionBuilder	builder(MyPaymentAddTransactionAction template)	create builder for MyPaymentAddTransactionAction instance
MyPaymentAddTransactionAction	copyDeep()
static MyPaymentAddTransactionAction	deepCopy(MyPaymentAddTransactionAction template)	factory method to create a deep copy of MyPaymentAddTransactionAction
@NotNull @Valid TransactionDraft	getTransaction()	Transaction to add to the Payment.
static MyPaymentAddTransactionAction	of()	factory method
static MyPaymentAddTransactionAction	of(MyPaymentAddTransactionAction template)	factory method to create a shallow copy MyPaymentAddTransactionAction
void	setTransaction(TransactionDraft transaction)	Transaction to add to the Payment.
static com.fasterxml.jackson.core.type.TypeReference<MyPaymentAddTransactionAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withMyPaymentAddTransactionAction(Function<MyPaymentAddTransactionAction,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.me.MyPaymentUpdateAction

getAction, withMyPaymentUpdateAction

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

get

Field Details

ADD_TRANSACTION

static final String ADD_TRANSACTION

discriminator value for MyPaymentAddTransactionAction

See Also:

• Constant Field Values

Method Details

getTransaction

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

Transaction to add to the Payment.

Returns:

transaction

setTransaction

void setTransaction(TransactionDraft transaction)

Transaction to add to the Payment.

Parameters:

transaction - value to be set

of

static MyPaymentAddTransactionAction of()

factory method

Returns:

instance of MyPaymentAddTransactionAction

of

static MyPaymentAddTransactionAction of(MyPaymentAddTransactionAction template)

factory method to create a shallow copy MyPaymentAddTransactionAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

MyPaymentAddTransactionAction copyDeep()

Specified by:

copyDeep in interface MyPaymentUpdateAction

deepCopy

@Nullable
static MyPaymentAddTransactionAction deepCopy(@Nullable
 MyPaymentAddTransactionAction template)

factory method to create a deep copy of MyPaymentAddTransactionAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static MyPaymentAddTransactionActionBuilder builder()

builder factory method for MyPaymentAddTransactionAction

Returns:

builder

builder

static MyPaymentAddTransactionActionBuilder builder(MyPaymentAddTransactionAction template)

create builder for MyPaymentAddTransactionAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withMyPaymentAddTransactionAction

default <T> T withMyPaymentAddTransactionAction(Function<MyPaymentAddTransactionAction,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<MyPaymentAddTransactionAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference