io.sphere.sdk.payments.messages

Class PaymentTransactionAddedMessage

java.lang.Object

io.sphere.sdk.models.Base

io.sphere.sdk.models.ResourceViewImpl<T,T>

io.sphere.sdk.models.ResourceImpl<Message>

io.sphere.sdk.messages.GenericMessageImpl<Payment>

io.sphere.sdk.payments.messages.PaymentTransactionAddedMessage

All Implemented Interfaces:

GenericMessage<Payment>, Message, CreationTimestamped, Identifiable<Message>, Referenceable<Message>, Resource<Message>, ResourceIdentifiable<Message>, ResourceView<Message,Message>, Timestamped, Versioned<Message>

public final class PaymentTransactionAddedMessage
extends GenericMessageImpl<Payment>

This message is the result of the AddTransaction update action.

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, AddTransaction

Field Summary

Fields

Modifier and Type	Field and Description
static MessageDerivateHint<PaymentTransactionAddedMessage>	MESSAGE_HINT
static String	MESSAGE_TYPE

Fields inherited from class io.sphere.sdk.messages.GenericMessageImpl

resource, resourceUserProvidedIdentifiers, resourceVersion, sequenceNumber, type

Method Summary

Modifier and Type	Method and Description
Transaction	getTransaction()

Methods inherited from class io.sphere.sdk.messages.GenericMessageImpl

as, equals, getPayload, getResource, getResourceUserProvidedIdentifiers, getResourceVersion, getSequenceNumber, getType, hashCode, toReference

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

getCreatedAt, getId, getLastModifiedAt, getVersion

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

toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.sphere.sdk.messages.Message

referenceOfId, referenceTypeId, typeReference

Methods inherited from interface io.sphere.sdk.models.Resource

getCreatedAt, getId, getLastModifiedAt, getVersion

Methods inherited from interface io.sphere.sdk.models.Versioned

of, of

Methods inherited from interface io.sphere.sdk.models.Referenceable

hasSameIdAs, toResourceIdentifier

Field Detail

MESSAGE_TYPE

public static final String MESSAGE_TYPE

See Also:

Constant Field Values

MESSAGE_HINT

public static final MessageDerivateHint<PaymentTransactionAddedMessage> MESSAGE_HINT

Method Detail

getTransaction

public Transaction getTransaction()