Skip to main content

PaymentIntentStatus

Enum PaymentIntentStatus 

Source
pub enum PaymentIntentStatus {
    RequiresPaymentMethod,
    RequiresAction,
    RequiresConfirmation,
    Processing,
    RequiresCapture,
    Succeeded,
    Canceled,
}
Expand description

The lifecycle state of a PaymentIntent.

Stripe advances a PaymentIntent through these states as the card is authenticated. Only the Succeeded and Cancel states are terminal.

Variants§

§

RequiresPaymentMethod

Stripe has created the intent and is waiting for a payment method.

§

RequiresAction

A payment method is attached and awaiting customer action.

§

RequiresConfirmation

The customer must confirm the payment on their own device.

§

Processing

The payment is processing and the result is not yet final.

§

RequiresCapture

Separate auth-and-capture flows park here until captured.

§

Succeeded

The payment completed and the funds are captured.

§

Canceled

The payment can no longer succeed without a new attempt.

Implementations§

Source§

impl PaymentIntentStatus

Source

pub const fn as_str(&self) -> &'static str

Return the wire string Stripe uses for this state.

§Returns
  • &'static str - the status value in a Stripe response.
Source

pub const fn is_terminal(&self) -> bool

Return whether no further state change is possible.

§Returns
  • bool - true for Succeeded and Canceled, the two states Stripe never moves out of.
Source

pub const fn can_transition_to(&self, next: &PaymentIntentStatus) -> bool

Return whether Stripe can move this state to next.

The table mirrors the PaymentIntent lifecycle Stripe documents: a failed confirmation returns the intent to RequiresPaymentMethod so the customer can retry, a manual capture flow parks on RequiresCapture, and neither Succeeded nor Canceled ever moves again.

§Arguments
  • &PaymentIntentStatus - the state Stripe would move into.
§Returns
  • bool - true when the transition is reachable.

Trait Implementations§

Source§

impl Clone for PaymentIntentStatus

Source§

fn clone(&self) -> PaymentIntentStatus

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for PaymentIntentStatus

Source§

impl Debug for PaymentIntentStatus

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for PaymentIntentStatus

Source§

fn default() -> PaymentIntentStatus

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for PaymentIntentStatus

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for PaymentIntentStatus

Source§

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

Render the wire string.

§Arguments
  • &mut Formatter<'_> - the formatter to write the value into.
§Returns

A Formatter writing the status as Stripe spells it.

Source§

impl Eq for PaymentIntentStatus

Source§

impl Hash for PaymentIntentStatus

Source§

fn hash<__H>(&self, state: &mut __H)
where __H: Hasher,

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for PaymentIntentStatus

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for PaymentIntentStatus

Source§

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. Read more
Source§

impl StructuralPartialEq for PaymentIntentStatus

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.