PaymentProcess
PaymentProcess
A PaymentProcess is used to define the way the payment process works as in: what states a Payment can be
in, and how it may transition from one state to another. Using the onTransitionStart()
hook, a
PaymentProcess can perform checks before allowing a state transition to occur, and the onTransitionEnd()
hook allows logic to be executed after a state change.
For detailed description of the interface members, see the StateMachineConfig docs.
Signature
interface PaymentProcess<State extends keyof CustomPaymentStates | string> extends InjectableStrategy {
transitions?: Transitions<State, State | PaymentState> & Partial<Transitions<PaymentState | State>>;
onTransitionStart?: OnTransitionStartFn<State | PaymentState, PaymentTransitionData>;
onTransitionEnd?: OnTransitionEndFn<State | PaymentState, PaymentTransitionData>;
onTransitionError?: OnTransitionErrorFn<State | PaymentState>;
}
Extends
Members
transitions
property
type:
Transitions<State, State | PaymentState> & Partial<Transitions<PaymentState | State>>
onTransitionStart
property
type:
OnTransitionStartFn<State | PaymentState, PaymentTransitionData>
onTransitionEnd
property
type:
OnTransitionEndFn<State | PaymentState, PaymentTransitionData>
onTransitionError
property
type:
OnTransitionErrorFn<State | PaymentState>