eshop-payment-domain/me.ahoo.wow.example.eshop.payment.domain.payment/Payment

Payment

@Description(value = "The payment of an order through the payment gateway")

The payment of an order, after the classic eShop's PaymentProcessor; its id is the order's:

REQUESTED -> SUCCEEDED -> REFUNDED
         \-> FAILED

RequestPayment creates it: OrderPaymentSaga sends it once the ordering context confirms the order's stock.
PaymentGatewaySaga charges the gateway for a requested payment and records the outcome: ConfirmPayment or FailPayment. OrderPaymentSaga then pays the order, or cancels it.
RefundPayment refunds a confirmed payment the order refused.

Recording an outcome the payment already has changes nothing, so a command sent again is harmless; recording the other outcome is a rejection.

Constructors

Payment

constructor(state: PaymentState)

Types

Rejections

object Rejections

The codes the aggregate rejects a command with, by their local names: the compiler and the kernel name them <context>.payment.<code>, as its peers read them from the api's generated contract.

Functions

onCommand

fun onCommand(command: ConfirmPayment): PaymentSucceeded?

fun onCommand(command: FailPayment): PaymentFailed?

fun onCommand(command: RefundPayment): PaymentRefunded?

fun onCommand(command: RequestPayment): PaymentRequested