---
title: "(Deprecated) List sweeps"
method: POST
path: "/bank_transfer/sweep/list"
tags: ["plaid"]
deprecated: true
---

# (Deprecated) List sweeps

`POST /bank_transfer/sweep/list`

> **Deprecated.**

The `/bank_transfer/sweep/list` endpoint fetches information about the sweeps matching the given filters.

## Request body

- BankTransferSweepListRequest — BankTransferSweepListRequest defines the request schema for `/bank_transfer/sweep/list`
  - `client_id` string — Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
  - `secret` string — Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
  - `origination_account_id` string, nullable — If multiple origination accounts are available, `origination_account_id` must be used to specify the account that the sweeps belong to.
  - `start_time` string, date-time, nullable — The start `created` datetime of sweeps to return (RFC 3339 format).
  - `end_time` string, date-time, nullable — The end `created` datetime of sweeps to return (RFC 3339 format).
  - `count` integer, nullable — The maximum number of sweeps to return.

## Response `200`

OK

- BankTransferSweepListResponse — BankTransferSweepListResponse defines the response schema for `/bank_transfer/sweep/list`
  - `sweeps` BankTransferSweep[], required
    - `id` string, required — Identifier of the sweep.
    - `created_at` string, date-time, required — The datetime when the sweep occurred, in RFC 3339 format.
    - `amount` string, required — The amount of the sweep.
    - `iso_currency_code` string, required — The currency of the sweep, e.g. "USD".
  - `request_id` string, required — A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

## Other responses

- `default` — Error response

---

[API](https://skmtc.net/plaid/apis/the-plaid-api.md) · [All operations](https://skmtc.net/plaid/apis/the-plaid-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/plaid/the-plaid-api/revisions/e536704a333f/schema)