io.sphere.sdk.payments.commands.updateactions

Class SetAmountPaid

java.lang.Object

io.sphere.sdk.models.Base

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

io.sphere.sdk.payments.commands.updateactions.SetAmountPaid

All Implemented Interfaces:

UpdateAction<Payment>

Deprecated.

This update action will be removed with the next major SDK update.

@Deprecated
public final class SetAmountPaid
extends UpdateActionImpl<Payment>

Sets the amount of money that has been paid by the customer. If no amount is provided, the amount is unset.

See also PaymentUpdateCommand.

withPayment(client(), payment -> {
    //set authorization
    final MonetaryAmount totalAmount = EURO_30;
    final ZonedDateTime until = ZonedDateTime.now().plusDays(7);
    final Payment updatedPayment = client().executeBlocking(PaymentUpdateCommand.of(payment, SetAuthorization.of(totalAmount, until)));

    assertThat(updatedPayment.getAmountAuthorized()).isEqualTo(totalAmount);
    assertThat(updatedPayment.getAuthorizedUntil()).isEqualTo(until);
    assertThat(updatedPayment.getAmountPaid()).isNull();

    //remove authorization, set amount paid
    final Payment updatedPayment2 = client().executeBlocking(PaymentUpdateCommand.of(updatedPayment, asList(SetAuthorization.ofRemove(), SetAmountPaid.of(totalAmount))));

    assertThat(updatedPayment2.getAmountAuthorized()).isNull();
    assertThat(updatedPayment2.getAuthorizedUntil()).isNull();
    assertThat(updatedPayment2.getAmountPaid()).isEqualTo(totalAmount);

    return updatedPayment2;
});
See the test code.

See Also:

Payment

Method Summary

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

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 SetAmountPaid of(@Nullable
                               javax.money.MonetaryAmount amount)

Deprecated.

getAmount

@Nullable
public javax.money.MonetaryAmount getAmount()

Deprecated.