Struct stripe::generated::core::setup_attempt::SetupAttempt

pub struct SetupAttempt {

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

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: SetupAttemptPaymentMethodDetails

setup_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 that associate with a provided SetupIntent.

Trait Implementations

impl Clone for SetupAttempt

fn clone(&self) -> SetupAttempt

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SetupAttempt

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

Formats the value using the given formatter.

impl Default for SetupAttempt

fn default() -> SetupAttempt

Returns the “default value” for a type.

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.

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.