--- title: "List sweeps" method: POST path: "/transfer/sweep/list" tags: ["plaid"] --- # List sweeps `POST /transfer/sweep/list` The `/transfer/sweep/list` endpoint fetches sweeps matching the given filters. ## Request body - TransferSweepListRequest — Defines the request schema for `/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. - `start_date` string, date-time, nullable — The start `created` datetime of sweeps to return (RFC 3339 format). - `end_date` 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. - `offset` integer — The number of sweeps to skip before returning results. - `amount` string, nullable — Filter sweeps to only those with the specified amount. - `status` 'pending' | 'posted' | 'settled' | 'funds_available' | '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. This is the terminal state of a successful credit sweep. `"returned"` - The sweep has been returned. This is the terminal state of a returned sweep. Returns of a sweep are extremely rare, since sweeps are money movement between your own bank account and your own Ledger. `"funds_available"` - Funds from the sweep have been released from hold and applied to the ledger's available balance. (Only applicable to deposits.) This is the terminal state of a successful deposit sweep. `"failed"` - The sweep has failed. This is the terminal state of a failed sweep. - `originator_client_id` string, nullable — Filter sweeps to only those with the specified originator client. - `funding_account_id` string, nullable — Filter sweeps to only those with the specified `funding_account_id`. - `transfer_id` string, nullable — Filter sweeps to only those with the included `transfer_id`. - `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. ## Response `200` OK - TransferSweepListResponse — Defines the response schema for `/transfer/sweep/list` - `sweeps` TransferSweep[], required - `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. - `expected_funds_available_date` string, date, nullable — The expected date when funds from a ledger deposit will be made available and can be withdrawn from the associated ledger balance. Only applies to deposits. This will be of the form YYYY-MM-DD. - `status` 'pending' | 'posted' | 'settled' | 'funds_available' | '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. This is the terminal state of a successful credit sweep. `"returned"` - The sweep has been returned. This is the terminal state of a returned sweep. Returns of a sweep are extremely rare, since sweeps are money movement between your own bank account and your own Ledger. `"funds_available"` - Funds from the sweep have been released from hold and applied to the ledger's available balance. (Only applicable to deposits.) This is the terminal state of a successful deposit sweep. `"failed"` - The sweep has failed. This is the terminal state of a failed sweep. - `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/RfP error codes](https://plaid.com/docs/errors/transfer/#rtprfp-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 --- [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)