Refund-amount states

The following table describes how refund amounts move from one state to another in WebSphere Commerce, as viewed by the Payment Rules subcomponent.

Because the Payment Rules subcomponent has a slightly different view of the credit state machine than WebSphere Commerce Payments, the states in this table are similar but not identical to the credit states shown in the credit state diagram in the payment plug-in specification. For information about the credit state machine and credit states supported by the WebSphere Commerce Payments, refer to the payment plug-in specification. The states shown in the following table are simplified states of the credit state machine used by WebSphere Commerce Payments.

Of these refund amount states, only DNE and Credited are considered valid target states in a payment action rule by the Payment Rules service.

Refund target states are not configurable.

Refund amount state Description Valid target for Payment Rules ?
DNE The credit object does not exist yet. This is the starting state of a credit. Valid action is Refund. Yes
Crediting A Refund action was performed but the results are still unknown. The operation will eventually succeed or fail. Credit objects in this state can be canceled (through a ReverseRefund). No
Credited A Refund action has been successfully executed. This is an end state. No actions are accepted in this state. Yes
Canceled A reverse action has been executed (ReverseRefund). This is an end state. No actions are accepted in this state. No
Failed An action has failed (Refund). This is an end state. No actions are accepted in this state. No