POST /transfer/sweep/list

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

Servers

https://production.plaid.com
https://sandbox.plaid.com

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`transfer_id`	String	No	Filter sweeps to only those with the included `transfer_id`.
`count`	Integer	No	The maximum number of sweeps to return. Default value: 25
`start_date`	String	No	The start `created` datetime of sweeps to return (RFC 3339 format).
`client_id`	String	No	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.
`end_date`	String	No	The end `created` datetime of sweeps to return (RFC 3339 format).
`amount`	String	No	Filter sweeps to only those with the specified amount.
`status`	String	No	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. Possible values: `"funds_available"` `"failed"` `"settled"` `"returned"` `null` `"posted"` `"pending"`
`funding_account_id`	String	No	Filter sweeps to only those with the specified `funding_account_id`.
`secret`	String	No	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.
`trigger`	String	No	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. Possible values: `"manual"` `"incoming"` `"balance_threshold"` `"automatic_aggregate"`
`offset`	Integer	No	The number of sweeps to skip before returning results. Default value: 0
`originator_client_id`	String	No	Filter sweeps to only those with the specified originator client.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.