Setup Attempts

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.

Was this section helpful? Yes No

List all SetupAttempts

GET / v1 / setup_attempts

The SetupAttempt object

Attributes

• id string Unique identifier for the object.
• object string, value is "setup_attempt" String representing the object’s type. Objects of the same type share the same value.
• application nullable string Expandable The value of application on the SetupIntent at the time of this confirmation.
• attach _ to _ self nullable 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 timestamp retrievable with publishable key Time at which the object was created. Measured in seconds since the Unix epoch.
• customer nullable string Expandable The value of customer on the SetupIntent at the time of this confirmation.
• customer _ account nullable string The value of customer_account on the SetupIntent at the time of this confirmation.
• flow _ directions nullable array of enums 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. Possible enum values inbound outbound
• livemode boolean retrievable with publishable key If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
• on _ behalf _ of nullable string Expandable The value of on_behalf_of on the SetupIntent at the time of this confirmation.
• payment _ method string Expandable retrievable with publishable key ID of the payment method used with this SetupAttempt.
• payment _ method _ details object Details about the payment method at the time of SetupIntent confirmation.
• setup _ error nullable object The error encountered during this attempt to confirm the SetupIntent, if any.
• setup _ intent string Expandable 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.

The SetupAttempt object

{ "id": "setatt_1ErTsH2eZvKYlo2CI7ukcoF7", "object": "setup_attempt", "application": null, "created": 1562004309, "customer": null, "flow_directions": null, "livemode": false, "on_behalf_of": null, "payment_method": "pm_1ErTsG2eZvKYlo2CH0DNen59", "payment_method_details": { "card": { "three_d_secure": null }, "type": "card" }, "setup_error": null, "setup_intent": "seti_1ErTsG2eZvKYlo2CKaT8MITz", "status": "succeeded", "usage": "off_session"}

List all SetupAttempts

GET / v1 / setup_attempts

Returns a list of SetupAttempts that associate with a provided SetupIntent.

Parameters

• setup _ intent string Required Only return SetupAttempts created by the SetupIntent specified by this ID.

More parameters

• created object
• ending _ before string
• limit integer
• starting _ after string

Returns

A dictionary with a data property that contains an array of up to limit SetupAttempts that are created by the specified SetupIntent, which start after SetupAttempts starting_after. Each entry in the array is a separate SetupAttempts object. If no other SetupAttempts are available, the resulting array is be empty. This request should never raise an error.

Response

{ "object": "list", "url": "/v1/setup_attempts", "has_more": false, "data": [ { "id": "setatt_1ErTsH2eZvKYlo2CI7ukcoF7", "object": "setup_attempt", "application": null, "created": 1562004309, "customer": null, "flow_directions": null, "livemode": false, "on_behalf_of": null, "payment_method": "pm_1ErTsG2eZvKYlo2CH0DNen59", "payment_method_details": { "card": { "three_d_secure": null }, "type": "card" }, "setup_error": null, "setup_intent": "seti_1ErTsG2eZvKYlo2CKaT8MITz", "status": "succeeded", "usage": "off_session" } ]}