OnPaymentCommands

This hook runs after commands have been applied to a Payment Actor from the create or applyCommands message. Commands returned from rules does not trigger the hook again.

For invariants that can only be checked after every OnPaymentCommands rule has run and its commands have been applied — for example rules that depend on data set by other rules — use the OnPaymentValidate hook instead.

Type

{
  hook: 'OnPaymentCommands'
  before: Payment // The payment before the commands were applied
  payment: Payment // The payment after the commands were applied
}

Effects

validationError

Reverts the payment state and returns the error to the caller.

messageActor

Sends a message to another actor. Responses are ignored.

scheduleJob

Schedules a job.

sendEmail

Queues an email for delivery through the Sendings system.

paymentCommand

Applies additional commands to the payment actor. Commands returned from rules do not trigger the hook again.