io.sphere.sdk.payments.commands.updateactions

Class ChangeAmountPlanned

java.lang.Object

io.sphere.sdk.models.Base

io.sphere.sdk.commands.UpdateActionImpl<Payment>

io.sphere.sdk.payments.commands.updateactions.ChangeAmountPlanned

All Implemented Interfaces:

UpdateAction<Payment>

public final class ChangeAmountPlanned
extends UpdateActionImpl<Payment>

Changes how much money this payment intends to receive from the customer. The value usually matches the cart or order gross total. Updating the amountPlanned may be required after a customer changed the cart or added/removed a cart discount during the checkout.

See also PaymentUpdateCommand.

withPayment(client(), (Payment payment) -> {
    assertThat(payment.getAmountPlanned()).isEqualTo(EURO_20);

    final PaymentUpdateCommand cmd = PaymentUpdateCommand.of(payment, ChangeAmountPlanned.of(EURO_10));
    final Payment updatedPayment = client().executeBlocking(cmd);

    assertThat(updatedPayment.getAmountPlanned()).isEqualTo(EURO_10);

    return updatedPayment;
});
See the test code.

See Also:

Payment

Method Summary

Modifier and Type	Method and Description
javax.money.MonetaryAmount	getAmount()
static ChangeAmountPlanned	of(javax.money.MonetaryAmount amount)

Methods inherited from class io.sphere.sdk.commands.UpdateActionImpl

getAction

Methods inherited from class io.sphere.sdk.models.Base

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

of

public static ChangeAmountPlanned of(@Nullable
                                     javax.money.MonetaryAmount amount)

getAmount

@Nullable
public javax.money.MonetaryAmount getAmount()