---
title: "(Deprecated) Retrieve a sweep"
method: POST
path: "/bank_transfer/sweep/get"
tags: ["plaid"]
deprecated: true
---

# (Deprecated) Retrieve a sweep

`POST /bank_transfer/sweep/get`

> **Deprecated.**

The `/bank_transfer/sweep/get` endpoint fetches information about the sweep corresponding to the given `sweep_id`.

## Request body

- BankTransferSweepGetRequest — Defines the request schema for `/bank_transfer/sweep/get`
  - `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.
  - `sweep_id` string, required — Identifier of the sweep.

## Response `200`

OK

- BankTransferSweepGetResponse — BankTransferSweepGetResponse defines the response schema for `/bank_transfer/sweep/get`
  - `sweep` BankTransferSweep, required — BankTransferSweep describes a sweep transfer.
    - `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

## Changes

- **2026-07-22** `94406d9a4d27` — 1 info
  - endpoint deprecated
- **2026-07-22** `a1bbca018160` — 13 warning
  - added the new `ASSETS_ERROR` enum value to the `error_type` response property for the response status `default`
  - added the new `CRA_MONITORING_ERROR` enum value to the `error_type` response property for the response status `default`
  - added the new `CREDIT_PROFILE_REPORT_ERROR` enum value to the `error_type` response property for the response status `default`
  - added the new `ENCOMPASS_ERROR` enum value to the `error_type` response property for the response status `default`
  - …9 more
- **2026-06-25** `80d23bfdc2e5` — 1 warning
  - added the new `IDEMPOTENCY_ERROR` enum value to the `error_type` response property for the response status `default`
- **2026-06-10** `fb8c3f188d8b` — 1 warning
  - added the new `BASE_REPORT_ERROR` enum value to the `error_type` response property for the response status `default`
- **2025-12-11** `465584b48c99` — 2 info
  - added the optional property `provided_account_subtypes` to the response with the `default` status
  - added the optional property `required_account_subtypes` to the response with the `default` status

[Full history](https://skmtc.dev/plaid/apis/the-plaid-api/changes/bank_transfer/sweep/get/post.md)

---

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