provider plaid POST /transfer/sweep/list
@utdk/plaid /transfer/sweep/list
List sweeps
The `/transfer/sweep/list` endpoint fetches sweeps matching the given filters.

Try it

Authentication
Configure credentials for The Plaid API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

transfersweeplist
POST/transfer/sweep/list
The `/transfer/sweep/list` endpoint fetches sweeps matching the given filters.

Input

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.

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.

The start `created` datetime of sweeps to return (RFC 3339 format).

The end `created` datetime of sweeps to return (RFC 3339 format).

The maximum number of sweeps to return.

The number of sweeps to skip before returning results.

Filter sweeps to only those with the specified amount.

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.

Filter sweeps to only those with the specified originator client.

Filter sweeps to only those with the specified `funding_account_id`.

Filter sweeps to only those with the included `transfer_id`.

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.

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import plaid from '@utdk/plaid';

await plaid.transfersweeplist({
  "count": 25,
  "offset": 0
})