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;
}

Properties

action force? state

Properties

Readonly action

action: "transitionState"

Optional Readonly force

force?: boolean

Set to true to skip validations when transitioning to the new State.

Readonly state

state: StateResourceIdentifier

ResourceIdentifier to a State.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc