Struct PaymentIntent 

pub struct PaymentIntent { /* private fields */ }

A PaymentIntent as returned by Stripe’s REST API.

A PaymentIntent tracks one customer payment attempt from creation through authentication to capture. The next_action field tells the browser what it still owes the user, and latest_charge links to the Charge Stripe created once the payment settled.

Read accessors are generated by #[derive(Getter)]. Only the fields a caller acts on are marked; amount and currency are deliberately unmarked because the pair is only meaningful together, so get_amount pairs them into a Money by hand instead of exposing two independently readable halves.

Implementations

impl PaymentIntent

pub fn new( id: String, amount: Money, status: PaymentIntentStatus, next_action: PaymentIntentNextAction, ) -> PaymentIntent

Build a PaymentIntent from its wire fields.

Arguments

• String - Stripe’s identifier for the intent.
• Money - the amount to capture.
• PaymentIntentStatus - the intent’s lifecycle state.
• PaymentIntentNextAction - what the customer must still do.

Returns

• Self - the assembled intent.

pub fn get_amount(&self) -> Result<Money, StripeParseError>

Return the amount this intent will capture.

The minor-unit count is paired with the currency recorded in the response, so the two never drift apart. The amount and currency fields are not exposed separately for this reason.

Returns

• Result<Money, StripeParseError> - the amount, or an error when the response carried a currency this crate does not model.

pub fn is_succeeded(&self) -> bool

Return whether the payment has been captured.

Returns

• bool - true once the intent reaches a terminal state that means money moved.

pub fn requires_action(&self) -> bool

Return whether the browser must handle a bank challenge.

Returns

• bool - true when the client still owes the user a 3-D Secure or redirect step.

impl PaymentIntent

pub fn get_id(&self) -> &String

pub fn get_status(&self) -> PaymentIntentStatus

pub fn get_next_action(&self) -> PaymentIntentNextAction

pub fn get_latest_charge(&self) -> Option<String>

pub fn try_get_latest_charge(&self) -> Option<String>

pub fn get_customer(&self) -> Option<String>

pub fn try_get_customer(&self) -> Option<String>

Trait Implementations

impl Clone for PaymentIntent

fn clone(&self) -> PaymentIntent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PaymentIntent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PaymentIntent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for PaymentIntent

impl PartialEq for PaymentIntent

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for PaymentIntent

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 PaymentIntent