Core Resources
Payment Methods
Products
Checkout
Payment Links
Billing
Capital
Connect
Fraud
Issuing
Terminal
Treasury
Entitlements
Sigma
Reporting
Financial Connections
Tax
Identity
Crypto
Climate
Forwarding
Privacy
Webhooks

The SetupAttempt object 

Attributes

  • idstring

    Unique identifier for the object.

  • objectstring

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

  • applicationnullable stringExpandable

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

  • attach_to_selfnullable 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.

  • createdtimestampretrievable with publishable key

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

  • customernullable stringExpandable

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

  • flow_directionsnullable 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

  • livemodebooleanretrievable with publishable key

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

  • on_behalf_ofnullable stringExpandable

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

  • payment_methodstringExpandableretrievable with publishable key

    ID of the payment method used with this SetupAttempt.

  • payment_method_detailsobject

    Details about the payment method at the time of SetupIntent confirmation.

  • setup_errornullable object

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

  • setup_intentstringExpandable

    ID of the SetupIntent that this attempt belongs to.

  • statusstring

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

  • usagestring

    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 

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

Parameters

  • setup_intentstringRequired

    Only return SetupAttempts created by the SetupIntent specified by this ID.

More parameters

  • createdobject

  • ending_beforestring

  • limitinteger

  • starting_afterstring

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.

GET /v1/setup_attempts
curl -G https://api.stripe.com/v1/setup_attempts \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
  -d limit=3 \
  -d setup_intent=seti_1ErTsG2eZvKYlo2CKaT8MITz
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"
    }
  ]
}

Payouts 

A Payout object is created when you receive funds from Stripe, or when you initiate a payout to either a bank account or debit card of a connected Stripe account. You can retrieve individual payouts, and list all payouts. Payouts are made on varying schedules, depending on your country and industry.

Related guide: Receiving payouts

Endpoints

Refunds 

Refund objects allow you to refund a previously created charge that isn’t refunded yet. Funds are refunded to the credit or debit card that’s initially charged.

Related guide: Refunds

Endpoints

Confirmation Token 

ConfirmationTokens help transport client side data collected by Stripe JS over to your server for confirming a PaymentIntent or SetupIntent. If the confirmation is successful, values present on the ConfirmationToken are written onto the Intent.

To learn more about how to use ConfirmationToken, visit the related guides:

Endpoints