Struct stripe::SetupAttempt

source · [−]

pub struct SetupAttempt {Show 14 fields
    pub id: SetupAttemptId,
    pub application: Option<Expandable<Application>>,
    pub attach_to_self: Option<bool>,
    pub created: Timestamp,
    pub customer: Option<Expandable<Customer>>,
    pub flow_directions: Option<Vec<SetupAttemptFlowDirections>>,
    pub livemode: bool,
    pub on_behalf_of: Option<Expandable<Account>>,
    pub payment_method: Expandable<PaymentMethod>,
    pub payment_method_details: SetupAttemptPaymentMethodDetails,
    pub setup_error: Option<Box<ApiErrors>>,
    pub setup_intent: Expandable<SetupIntent>,
    pub status: String,
    pub usage: String,
}

Expand description

The resource representing a Stripe “PaymentFlowsSetupIntentSetupAttempt”.

For more details see https://stripe.com/docs/api/setup_attempts/object

Fields

id: SetupAttemptId

Unique identifier for the object.

application: Option<Expandable<Application>>

The value of application on the SetupIntent at the time of this confirmation.

attach_to_self: Option<bool>

If present, the SetupIntent’s payment method will be attached to the in-context Stripe Account.

It can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers.

It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer.

created: Timestamp

Time at which the object was created.

Measured in seconds since the Unix epoch.

customer: Option<Expandable<Customer>>

The value of customer on the SetupIntent at the time of this confirmation.

flow_directions: Option<Vec<SetupAttemptFlowDirections>>

Indicates the directions of money movement for which this payment method is intended to be used.

Include inbound if you intend to use the payment method as the origin to pull funds from.

Include outbound if you intend to use the payment method as the destination to send funds to. You can include both if you intend to use the payment method for both purposes.

livemode: bool

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

on_behalf_of: Option<Expandable<Account>>

The value of on_behalf_of on the SetupIntent at the time of this confirmation.

payment_method: Expandable<PaymentMethod>

ID of the payment method used with this SetupAttempt.

payment_method_details: SetupAttemptPaymentMethodDetailssetup_error: Option<Box<ApiErrors>>

The error encountered during this attempt to confirm the SetupIntent, if any.

setup_intent: Expandable<SetupIntent>

ID of the SetupIntent that this attempt belongs to.

status: String

Status of this SetupAttempt, one of requires_confirmation, requires_action, processing, succeeded, failed, or abandoned.

usage: String

The value of usage on the SetupIntent at the time of this confirmation, one of off_session or on_session.

Implementations

impl SetupAttempt

pub fn list(
client: &Client,
params: &ListSetupAttempts<'_>
) -> Response<List<SetupAttempt>>

Returns a list of SetupAttempts associated with a provided SetupIntent.

Trait Implementations

impl Clone for SetupAttempt

fn clone(&self) -> SetupAttempt

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl Debug for SetupAttempt

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

Formats the value using the given formatter. Read more

impl Default for SetupAttempt

fn default() -> SetupAttempt

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

impl<'de> Deserialize<'de> for SetupAttempt

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
__D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl Object for SetupAttempt

type Id = SetupAttemptId

The canonical id type for this object.

fn id(&self) -> Self::Id

The id of the object.

fn object(&self) -> &'static str

The object’s type, typically represented in wire format as the object property.

impl Serialize for SetupAttempt

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations

impl RefUnwindSafe for SetupAttempt

impl Send for SetupAttempt

impl Sync for SetupAttempt

impl Unpin for SetupAttempt

impl UnwindSafe for SetupAttempt

Blanket Implementations

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

const: unstable · 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.

impl<T> Same<T> for T

type Output = T

Should always be Self

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

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

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

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

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