{
  "opencollection": "1.0.0",
  "info": {
    "name": "Stripe Accounts Account Setup Intents API",
    "version": "2023-10-16"
  },
  "items": [
    {
      "info": {
        "name": "Setup Intents",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "GetSetupIntents",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.stripe.com/v1/setup_intents",
            "params": [
              {
                "name": "attach_to_self",
                "value": "",
                "type": "query",
                "description": "If present, the SetupIntent's payment method will be attached to the in-context Stripe Account.\n\nIt 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."
              },
              {
                "name": "created",
                "value": "",
                "type": "query",
                "description": "A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options."
              },
              {
                "name": "customer",
                "value": "",
                "type": "query",
                "description": "Only return SetupIntents for the customer specified by this customer ID."
              },
              {
                "name": "ending_before",
                "value": "",
                "type": "query",
                "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list."
              },
              {
                "name": "expand",
                "value": "",
                "type": "query",
                "description": "Specifies which fields in the response should be expanded."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10."
              },
              {
                "name": "payment_method",
                "value": "",
                "type": "query",
                "description": "Only return SetupIntents that associate with the specified payment method."
              },
              {
                "name": "starting_after",
                "value": "",
                "type": "query",
                "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list."
              }
            ],
            "body": {
              "type": "form-urlencoded",
              "data": []
            }
          },
          "docs": "<p>Returns a list of SetupIntents.</p>"
        },
        {
          "info": {
            "name": "PostSetupIntents",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.stripe.com/v1/setup_intents",
            "body": {
              "type": "form-urlencoded",
              "data": []
            }
          },
          "docs": "<p>Creates a SetupIntent object.</p>\n\n<p>After you create the SetupIntent, attach a payment method and <a href=\"/docs/api/setup_intents/confirm\">confirm</a>\nit to collect any required permissions to charge the payment method later.</p>"
        },
        {
          "info": {
            "name": "GetSetupIntentsIntent",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.stripe.com/v1/setup_intents/:intent",
            "params": [
              {
                "name": "client_secret",
                "value": "",
                "type": "query",
                "description": "The client secret of the SetupIntent. We require this string if you use a publishable key to retrieve the SetupIntent."
              },
              {
                "name": "expand",
                "value": "",
                "type": "query",
                "description": "Specifies which fields in the response should be expanded."
              },
              {
                "name": "intent",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "form-urlencoded",
              "data": []
            }
          },
          "docs": "<p>Retrieves the details of a SetupIntent that has previously been created. </p>\n\n<p>Client-side retrieval using a publishable key is allowed when the <code>client_secret</code> is provided in the query string. </p>\n\n<p>When retrieved with a publishable key, only a subset of properties will be returned. Please refer to the <a href=\"#setup_intent_object\">SetupIntent</a> object reference for more details.</p>"
        },
        {
          "info": {
            "name": "PostSetupIntentsIntent",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.stripe.com/v1/setup_intents/:intent",
            "params": [
              {
                "name": "intent",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "form-urlencoded",
              "data": []
            }
          },
          "docs": "<p>Updates a SetupIntent object.</p>"
        },
        {
          "info": {
            "name": "PostSetupIntentsIntentCancel",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.stripe.com/v1/setup_intents/:intent/cancel",
            "params": [
              {
                "name": "intent",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "form-urlencoded",
              "data": []
            }
          },
          "docs": "<p>You can cancel a SetupIntent object when it’s in one of these statuses: <code>requires_payment_method</code>, <code>requires_confirmation</code>, or <code>requires_action</code>. </p>\n\n<p>After you cancel it, setup is abandoned and any operations on the SetupIntent fail with an error.</p>"
        },
        {
          "info": {
            "name": "PostSetupIntentsIntentConfirm",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.stripe.com/v1/setup_intents/:intent/confirm",
            "params": [
              {
                "name": "intent",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "form-urlencoded",
              "data": []
            }
          },
          "docs": "<p>Confirm that your customer intends to set up the current or\nprovided payment method. For example, you would confirm a SetupIntent\nwhen a customer hits the “Save” button on a payment method management\npage on your website.</p>\n\n<p>If the selected payment method does not require any additional\nsteps from the customer, the SetupIntent will transition to the\n<code>succeeded</code> status.</p>\n\n<p>Otherwise, it will transition to the <code>requires_action</code> status and\nsuggest additional actio"
        },
        {
          "info": {
            "name": "PostSetupIntentsIntentVerifyMicrodeposits",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.stripe.com/v1/setup_intents/:intent/verify_microdeposits",
            "params": [
              {
                "name": "intent",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "form-urlencoded",
              "data": []
            }
          },
          "docs": "<p>Verifies microdeposits on a SetupIntent object.</p>"
        },
        {
          "info": {
            "name": "List Setup Attempts",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.stripe.com/v1/setup_attempts",
            "params": [
              {
                "name": "setup_intent",
                "value": "",
                "type": "query"
              },
              {
                "name": "ending_before",
                "value": "",
                "type": "query"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query"
              },
              {
                "name": "starting_after",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "<p>Returns a list of SetupAttempts that associate with a provided SetupIntent.</p>"
        }
      ]
    }
  ],
  "bundled": true
}