Struct SetupAttempt

pub struct SetupAttempt {

    pub application: Option<Expandable<Application>>,
    pub attach_to_self: Option<bool>,
    pub created: i64,
    pub customer: Option<Expandable<Customer>>,
    pub flow_directions: Option<Vec<SetupAttemptFlowDirections>>,
    pub id: SetupAttemptId,
    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,
}

A SetupAttempt describes one attempted confirmation of a SetupIntent, whether that confirmation is successful or unsuccessful. You can use SetupAttempts to inspect details of a specific attempt at setting up a payment method using a SetupIntent.

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

Fields

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

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.

id: SetupAttemptId

Unique identifier for the object.

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.

Trait Implementations

impl Clone for SetupAttempt

fn clone(&self) -> SetupAttempt

Returns a duplicate 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<(), Error>

Formats the value using the given formatter.

impl Deserialize for SetupAttempt

fn begin(out: &mut Option<SetupAttempt>) -> &mut dyn Visitor

The only correct implementation of this method is:

impl Object for SetupAttempt

type Id = SetupAttemptId

The canonical id type for this object.

fn id(&self) -> &<SetupAttempt as Object>::Id

The id of the object.

fn into_id(self) -> <SetupAttempt as Object>::Id

The owned id of the object.

impl ObjectDeser for SetupAttempt

type Builder = SetupAttemptBuilder