io.sphere.sdk.payments.commands.updateactions

Class SetAuthorization

java.lang.Object

io.sphere.sdk.models.Base

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

io.sphere.sdk.payments.commands.updateactions.SetAuthorization

All Implemented Interfaces:

UpdateAction<Payment>

Deprecated.

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

public final class SetAuthorization
extends UpdateActionImpl<Payment>

Sets the amount of money that has been authorized and optionally until when the authorization is valid. If no amount is provided, the authorization 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.
ZonedDateTime	getUntil() Deprecated.
static SetAuthorization	of(javax.money.MonetaryAmount amount) Deprecated.
static SetAuthorization	of(javax.money.MonetaryAmount amount, ZonedDateTime until) Deprecated.
static SetAuthorization	ofRemove() 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 SetAuthorization of(@Nullable
                                  javax.money.MonetaryAmount amount)

Deprecated.

of

public static SetAuthorization of(@Nullable
                                  javax.money.MonetaryAmount amount,
                                  @Nullable
                                  ZonedDateTime until)

Deprecated.

getAmount

@Nullable
public javax.money.MonetaryAmount getAmount()

Deprecated.

getUntil

@Nullable
public ZonedDateTime getUntil()

Deprecated.

ofRemove

public static SetAuthorization ofRemove()

Deprecated.