io.sphere.sdk.payments.commands.updateactions

Class AddTransaction

java.lang.Object

io.sphere.sdk.models.Base

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

io.sphere.sdk.payments.commands.updateactions.AddTransaction

All Implemented Interfaces:

UpdateAction<Payment>

public final class AddTransaction
extends UpdateActionImpl<Payment>

Adds a new financial transaction. Transactions should only be set if a notification from the PSP was received that a transaction was completed successfully. E.g. in the case of a refund, the transaction is not added when the refund-request is being sent to the PSP or the PSP acknowledges the request (the interfaceInteractions may be used for these), but when the PSP sends a notification that the refund has been executed.

See also PaymentUpdateCommand.

withCustomerAndFilledCart(client(), (customer, cart) -> {
    final MonetaryAmount totalAmount = cart.getTotalPrice();
    final PaymentMethodInfo paymentMethodInfo = PaymentMethodInfoBuilder.of()
            .paymentInterface(randomKey())
            .method("CREDIT_CARD")
            .build();
    final TransactionDraft chargeTransaction = TransactionDraftBuilder
            .of(TransactionType.CHARGE, totalAmount, ZonedDateTime.now())
            .build();
    final PaymentDraftBuilder paymentDraftBuilder = PaymentDraftBuilder.of(totalAmount)
            .customer(customer)
            .paymentMethodInfo(paymentMethodInfo)
            .amountPaid(totalAmount)
            .transactions(Collections.singletonList(chargeTransaction));
    final Payment payment = client().executeBlocking(PaymentCreateCommand.of(paymentDraftBuilder.build()));

    assertThat(payment.getCustomer()).isEqualTo(payment.getCustomer());
    assertThat(payment.getPaymentMethodInfo()).isEqualTo(paymentMethodInfo);
    assertThat(payment.getAmountPlanned()).isEqualTo(totalAmount);

    final MonetaryAmount firstRefundAmount = EURO_10;
    final TransactionDraft firstRefundTransaction = TransactionDraftBuilder.of(TransactionType.REFUND, firstRefundAmount, ZonedDateTime.now()).build();
    final Payment paymentWithFirstRefund = client().executeBlocking(PaymentUpdateCommand.of(payment, asList(SetAmountRefunded.of(firstRefundAmount), AddTransaction.of(firstRefundTransaction))));

    assertThat(paymentWithFirstRefund.getTransactions()).hasSize(2);
    assertThat(paymentWithFirstRefund.getTransactions().get(0).getId()).isNotEmpty();

    final Query<PaymentTransactionAddedMessage> messageQuery = MessageQuery.of().withPredicates(m -> m.resource().is(payment))
            .forMessageType(PaymentTransactionAddedMessage.MESSAGE_HINT);

    assertEventually(() -> {
        final PagedQueryResult<PaymentTransactionAddedMessage> messageQueryResult = client().executeBlocking(messageQuery);
        assertThat(messageQueryResult.getTotal()).isGreaterThanOrEqualTo(1L);
        final PaymentTransactionAddedMessage paymentTransactionAddedMessage = messageQueryResult.head().get();
        assertThat(paymentTransactionAddedMessage.getTransaction().getTimestamp()).isEqualTo(firstRefundTransaction.getTimestamp());
    });

    final MonetaryAmount secondRefundAmount = EURO_5;
    final TransactionDraft secondRefundTransaction = TransactionDraftBuilder.of(TransactionType.REFUND, secondRefundAmount, ZonedDateTime.now()).build();
    final MonetaryAmount totalRefundAmount = secondRefundAmount.add(paymentWithFirstRefund.getAmountRefunded());
    final Payment paymentWithSecondRefund = client().executeBlocking(PaymentUpdateCommand.of(paymentWithFirstRefund, asList(SetAmountRefunded.of(totalRefundAmount), AddTransaction.of(secondRefundTransaction))));

    assertThat(paymentWithSecondRefund.getTransactions()).hasSize(3);
    assertThat(paymentWithSecondRefund.getAmountRefunded()).isEqualTo(totalRefundAmount);
});
See the test code.

See Also:

Payment.getTransactions(), PaymentTransactionAddedMessage

Method Summary

Modifier and Type	Method and Description
TransactionDraft	getTransaction()
static AddTransaction	of(TransactionDraft transaction)

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 AddTransaction of(TransactionDraft transaction)

getTransaction

public TransactionDraft getTransaction()