---
title: "Retrieve a sweep"
method: POST
path: "/transfer/sweep/get"
tags: ["plaid"]
---

# Retrieve a sweep

`POST /transfer/sweep/get`

The `/transfer/sweep/get` endpoint fetches a sweep corresponding to the given `sweep_id`.

## Request body

- TransferSweepGetRequest — Defines the request schema for `/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 — Plaid's unique identifier for the sweep (UUID) or a shortened form consisting of the first 8 characters of the identifier (8-digit hexadecimal string).

## Response `200`

OK

- TransferSweepGetResponse — Defines the response schema for `/transfer/sweep/get`
  - `sweep` TransferSweep, required — Describes a sweep of funds to / from the sweep account. A sweep is associated with many sweep events (events of type `swept` or `return_swept`) which can be retrieved by invoking the `/transfer/event/list` endpoint with the corresponding `sweep_id`. `swept` events occur when the transfer amount is credited or debited from your sweep account, depending on the `type` of the transfer. `return_swept` events occur when a transfer is returned and Plaid undoes the credit or debit. The total sum of the `swept` and `return_swept` events is equal to the `amount` of the sweep Plaid creates and matches the amount of the entry on your sweep account ledger.
    - `id` string, required — Identifier of the sweep.
    - `funding_account_id` string, required — The id of the funding account to use, available in the Plaid Dashboard. This determines which of your business checking accounts will be credited or debited.
    - `ledger_id` string, nullable — Plaid’s unique identifier for a Plaid Ledger Balance.
    - `created` string, date-time, required — The datetime when the sweep occurred, in RFC 3339 format.
    - `amount` string, required — Signed decimal amount of the sweep as it appears on your sweep account ledger (e.g. "-10.00") If amount is not present, the sweep was net-settled to zero and outstanding debits and credits between the sweep account and Plaid are balanced.
    - `iso_currency_code` string, required — The currency of the sweep, e.g. "USD".
    - `settled` string, date, nullable, required — The date when the sweep settled, in the YYYY-MM-DD format.
    - `status` 'pending' | 'posted' | 'settled' | 'returned' | 'failed' | 'null', nullable — The status of a sweep transfer `"pending"` - The sweep is currently pending `"posted"` - The sweep has been posted `"settled"` - The sweep has settled `"returned"` - The sweep has been returned `"failed"` - The sweep has failed
    - `trigger` 'manual' | 'incoming' | 'balance_threshold' | 'automatic_aggregate', nullable — The trigger of the sweep `"manual"` - The sweep is created manually by the customer `"incoming"` - The sweep is created by incoming funds flow (e.g. Incoming Wire) `"balance_threshold"` - The sweep is created by balance threshold setting `"automatic_aggregate"` - The sweep is created by the Plaid automatic aggregation process. These funds did not pass through the Plaid Ledger balance.
    - `description` string — The description of the deposit that will be passed to the receiving bank (up to 10 characters). Note that banks utilize this field differently, and may or may not show it on the bank statement.
    - `network_trace_id` string, nullable — The trace identifier for the transfer based on its network. This will only be set after the transfer has posted. For `ach` or `same-day-ach` transfers, this is the ACH trace number. For `rtp` transfers, this is the Transaction Identification number. For `wire` transfers, this is the IMAD (Input Message Accountability Data) number.
    - `failure_reason` SweepFailure, nullable — The failure reason if the status for a sweep is `"failed"` or `"returned"`. Null value otherwise.
      - `failure_code` string, nullable — The failure code, e.g. `R01`. A failure code will be provided if and only if the sweep status is `returned`. See [ACH return codes](https://plaid.com/docs/errors/transfer/#ach-return-codes) for a full listing of ACH return codes and [RTP error codes](https://plaid.com/docs/errors/transfer/#rtp-error-codes) for RTP error codes.
      - `description` string, nullable — A human-readable description of the reason for the failure or reversal.
  - `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

- **2025-01-15** `5dbeedb71831` — 1 info
  - added the optional property `sweep/failure_reason` to the response with the `200` status
- **2024-09-04** `a2c34406c317` — 5 warning, 2 info
  - added the new `PARTNER_ERROR` enum value to the `error_type` response property for the response status `default`
  - added the new `SANDBOX_ERROR` enum value to the `error_type` response property for the response status `default`
  - added the new `TRANSACTIONS_ERROR` enum value to the `error_type` response property for the response status `default`
  - added the new `TRANSACTION_ERROR` enum value to the `error_type` response property for the response status `default`
  - …3 more
- **2024-02-21** `5de70cc1e6ca` — 6 warning, 12 info
  - removed the optional property `error_code_reason` from the response with the `default` status
  - removed the optional property `provided_account_subtypes` from the response with the `default` status
  - removed the optional property `required_account_subtypes` from the response with the `default` status
  - removed the optional property `sweep/expected_funds_available_date` from the response with the `200` status
  - …14 more

[Change history](https://skmtc.dev/plaid/apis/the-plaid-api/changes/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.dev/plaid/apis/the-plaid-api/revisions/2fcba991badd?raw)