Enum PaymentTransactionStatus 

#[non_exhaustive]
pub enum PaymentTransactionStatus {
    Pending,
    Processing,
    RequiresAction,
    Completed,
    Failed,
    Cancelled,
    Refunded,
    PartiallyRefunded,
    Disputed,
}

Payment transaction status in the processing lifecycle

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Pending

Payment is pending processing

Processing

Payment is being processed

RequiresAction

Payment requires additional action (e.g., 3D Secure)

Completed

Payment was successfully completed

Failed

Payment failed

Cancelled

Payment was cancelled

Refunded

Payment was refunded (fully)

PartiallyRefunded

Payment was partially refunded

Disputed

Payment is disputed/chargeback

Implementations

impl PaymentTransactionStatus

pub fn can_transition_to(self, next: PaymentTransactionStatus) -> bool

Check if a status transition is allowed.

pub const fn is_terminal(self) -> bool

Returns true if this status is a terminal state.

pub const fn is_successful(self) -> bool

Returns true if this status represents a successful payment.

pub const fn is_in_progress(self) -> bool

Returns true if this payment is still in progress.

pub const fn is_refundable(self) -> bool

Returns true if a payment in this status may be refunded.

Only successfully captured funds can be refunded: a Completed payment, or one that is already PartiallyRefunded (so the remaining balance can be returned). Pending, Processing, RequiresAction, Failed, Cancelled, Disputed, and fully Refunded payments are not refundable.

Trait Implementations

impl Clone for PaymentTransactionStatus

fn clone(&self) -> PaymentTransactionStatus

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for PaymentTransactionStatus

impl Debug for PaymentTransactionStatus

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for PaymentTransactionStatus

fn default() -> PaymentTransactionStatus

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PaymentTransactionStatus

fn deserialize<__D>( __deserializer: __D, ) -> Result<PaymentTransactionStatus, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PaymentTransactionStatus

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Eq for PaymentTransactionStatus

impl FromStr for PaymentTransactionStatus

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str( s: &str, ) -> Result<PaymentTransactionStatus, <PaymentTransactionStatus as FromStr>::Err>

Parses a string s to return a value of this type.

impl PartialEq for PaymentTransactionStatus

fn eq(&self, other: &PaymentTransactionStatus) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for PaymentTransactionStatus

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for PaymentTransactionStatus

impl TryFrom<&str> for PaymentTransactionStatus

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from( s: &str, ) -> Result<PaymentTransactionStatus, <PaymentTransactionStatus as TryFrom<&str>>::Error>

Performs the conversion.