Mayson Monorepo Documentation
    Preparing search index...

    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.

    interface SetupAttempt {
        id: string;
        object: "setup_attempt";
        application: string | Application;
        attach_to_self?: boolean;
        created: number;
        customer: string | Stripe.Customer | DeletedCustomer;
        customer_account: string;
        flow_directions: Stripe.SetupAttempt.FlowDirection[];
        livemode: boolean;
        on_behalf_of: string | Stripe.Account;
        payment_method: string | Stripe.PaymentMethod;
        payment_method_details: Stripe.SetupAttempt.PaymentMethodDetails;
        setup_error: Stripe.SetupAttempt.SetupError;
        setup_intent: string | Stripe.SetupIntent;
        status: string;
        usage: string;
    }
    Index

    Properties

    id: string

    Unique identifier for the object.

    object: "setup_attempt"

    String representing the object's type. Objects of the same type share the same value.

    application: string | Application

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

    attach_to_self?: boolean

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

    Time at which the object was created. Measured in seconds since the Unix epoch.

    customer: string | Stripe.Customer | DeletedCustomer

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

    customer_account: string

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

    flow_directions: Stripe.SetupAttempt.FlowDirection[]

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

    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: string | Stripe.Account

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

    payment_method: string | Stripe.PaymentMethod

    ID of the payment method used with this SetupAttempt.

    payment_method_details: Stripe.SetupAttempt.PaymentMethodDetails

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

    setup_intent: string | Stripe.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.