io.sphere.sdk.payments.commands.updateactions

Class SetAmountRefunded

java.lang.Object

io.sphere.sdk.models.Base

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

io.sphere.sdk.payments.commands.updateactions.SetAmountRefunded

All Implemented Interfaces:

UpdateAction<Payment>

Deprecated.

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

public final class SetAmountRefunded
extends UpdateActionImpl<Payment>

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

See also PaymentUpdateCommand.

withPayment(client(), payment -> {

    final MonetaryAmount refundedAmount = payment.getAmountPlanned().divide(2);
    final Payment updatedPayment = client().executeBlocking(PaymentUpdateCommand.of(payment, SetAmountRefunded.of(refundedAmount)));

    assertThat(updatedPayment.getAmountRefunded()).isEqualTo(refundedAmount);

    return updatedPayment;
});
See the test code.

Example with multiple refunds:

withPayment(client(), payBuilder -> payBuilder.amountPaid(payBuilder.getAmountPlanned()), payment -> {
    final MonetaryAmount totalAmount = payment.getAmountPlanned();
    assertThat(payment.getAmountPaid()).as("amount paid").isEqualTo(totalAmount);

    final MonetaryAmount firstRefundedAmount = totalAmount.scaleByPowerOfTen(-1);
    final Payment firstRefundPayment = client().executeBlocking(PaymentUpdateCommand.of(payment, asList(SetAmountRefunded.of(firstRefundedAmount))));

    assertThat(firstRefundPayment.getAmountRefunded()).as("first refunded").isEqualTo(firstRefundedAmount);

    final MonetaryAmount secondRefundedAmount = firstRefundedAmount.multiply(2);
    //important, because SetAmountRefunded sets the total value
    final MonetaryAmount totalRefundedAmount = firstRefundPayment.getAmountRefunded().add(secondRefundedAmount);

    final Payment secondRefundPayment = client().executeBlocking(PaymentUpdateCommand.of(firstRefundPayment, asList(SetAmountRefunded.of(totalRefundedAmount))));

    assertThat(secondRefundPayment.getAmountRefunded()).as("total refunded").isEqualTo(totalRefundedAmount);

    return secondRefundPayment;
});
See the test code.

See Also:

Payment

Method Summary

Modifier and Type	Method and Description
javax.money.MonetaryAmount	getAmount() Deprecated.
static SetAmountRefunded	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 SetAmountRefunded of(@Nullable
                                   javax.money.MonetaryAmount amount)

Deprecated.

getAmount

@Nullable
public javax.money.MonetaryAmount getAmount()

Deprecated.