@gradientedge/commercetools-utils
    Preparing search index...

    Interface PaymentTransitionStateAction

    If the Payment has no current State, initial must be true for the new State. If the existing State has transitions set, the new State must be a valid transition. If the existing State has no transitions set, no validations are performed when transitioning to the new State.

    Transitioning the State of a Payment produces the [PaymentStatusStateTransition](ctp:api:type:PaymentStatusStateTransitionMessage) Message.
    interface PaymentTransitionStateAction {
        action: "transitionState";
        force?: boolean;
        state: StateResourceIdentifier;
    }

    Hierarchy (View Summary)

    Index
    action force? state
    action: "transitionState"
    force?: boolean

    Whether to skip validations when transitioning to the new State.

    state: StateResourceIdentifier

    ResourceIdentifier to a State.

    Settings
    Member Visibility

    On This Page
    Properties