List sweeps

POST /bank_transfer/sweep/list

The /bank_transfer/sweep/list endpoint fetches information about the sweeps matching the given filters.

Request Body

Required

BankTransferSweepListRequest defines the request schema for /bank_transfer/sweep/list

Parameters

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.
origination_account_id
string
If multiple origination accounts are available, origination_account_id must be used to specify the account that the sweeps belong to.
start_time
string
The start created datetime of sweeps to return (RFC 3339 format).
end_time
string
The end created datetime of sweeps to return (RFC 3339 format).
count
integer
The maximum number of sweeps to return.

Response

BankTransferSweepListResponse defines the response schema for /bank_transfer/sweep/list

Response Properties

sweeps
required, array[object]
id
required, string
Identifier of the sweep.
created_at
required, string
The datetime when the sweep occurred, in RFC 3339 format.
amount
required, string
The amount of the sweep.
iso_currency_code
required, string
The currency of the sweep, e.g. “USD”.
request_id
required, string
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.