{
  "opencollection": "1.0.0",
  "info": {
    "name": "Stripe Accounts Account Payouts API",
    "version": "2023-10-16"
  },
  "items": [
    {
      "info": {
        "name": "Payouts",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "GetPayouts",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.stripe.com/v1/payouts",
            "params": [
              {
                "name": "arrival_date",
                "value": "",
                "type": "query"
              },
              {
                "name": "created",
                "value": "",
                "type": "query"
              },
              {
                "name": "destination",
                "value": "",
                "type": "query",
                "description": "The ID of an external account - only return payouts sent to this external account."
              },
              {
                "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": "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."
              },
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "Only return payouts that have the given status: `pending`, `paid`, `failed`, or `canceled`."
              }
            ],
            "body": {
              "type": "form-urlencoded",
              "data": []
            }
          },
          "docs": "<p>Returns a list of existing payouts sent to third-party bank accounts or payouts that Stripe sent to you. The payouts return in sorted order, with the most recently created payouts appearing first.</p>"
        },
        {
          "info": {
            "name": "PostPayouts",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.stripe.com/v1/payouts",
            "body": {
              "type": "form-urlencoded",
              "data": []
            }
          },
          "docs": "<p>To send funds to your own bank account, create a new payout object. Your <a href=\"#balance\">Stripe balance</a> must cover the payout amount. If it doesn’t, you receive an “Insufficient Funds” error.</p>\n\n<p>If your API key is in test mode, money won’t actually be sent, though every other action occurs as if you’re in live mode.</p>\n\n<p>If you create a manual payout on a Stripe account that uses multiple payment source types, you need to specify the source type balance that the payout draws fr"
        },
        {
          "info": {
            "name": "GetPayoutsPayout",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.stripe.com/v1/payouts/:payout",
            "params": [
              {
                "name": "expand",
                "value": "",
                "type": "query",
                "description": "Specifies which fields in the response should be expanded."
              },
              {
                "name": "payout",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "form-urlencoded",
              "data": []
            }
          },
          "docs": "<p>Retrieves the details of an existing payout. Supply the unique payout ID from either a payout creation request or the payout list. Stripe returns the corresponding payout information.</p>"
        },
        {
          "info": {
            "name": "PostPayoutsPayout",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.stripe.com/v1/payouts/:payout",
            "params": [
              {
                "name": "payout",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "form-urlencoded",
              "data": []
            }
          },
          "docs": "<p>Updates the specified payout by setting the values of the parameters you pass. We don’t change parameters that you don’t provide. This request only accepts the metadata as arguments.</p>"
        },
        {
          "info": {
            "name": "PostPayoutsPayoutCancel",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.stripe.com/v1/payouts/:payout/cancel",
            "params": [
              {
                "name": "payout",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "form-urlencoded",
              "data": []
            }
          },
          "docs": "<p>You can cancel a previously created payout if it hasn’t been paid out yet. Stripe refunds the funds to your available balance. You can’t cancel automatic Stripe payouts.</p>"
        },
        {
          "info": {
            "name": "PostPayoutsPayoutReverse",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.stripe.com/v1/payouts/:payout/reverse",
            "params": [
              {
                "name": "payout",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "form-urlencoded",
              "data": []
            }
          },
          "docs": "<p>Reverses a payout by debiting the destination bank account. At this time, you can only reverse payouts for connected accounts to US bank accounts. If the payout is in the <code>pending</code> status, use <code>/v1/payouts/:id/cancel</code> instead.</p>\n\n<p>By requesting a reversal through <code>/v1/payouts/:id/reverse</code>, you confirm that the authorized signatory of the selected bank account authorizes the debit on the bank account and that no other authorization is required.</p>"
        }
      ]
    }
  ],
  "bundled": true
}