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

---

[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/versions/64c4514ea59b/schema)