bankTransferSweepList
The /bank_transfer/sweep/list endpoint fetches information about the sweeps matching the given filters.
Authorization
PLAID-CLIENT-ID PLAID-SECRET Plaid-Version In: header
In: header
In: header
Request Body
application/json
BankTransferSweepListRequest defines the request schema for /bank_transfer/sweep/list
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.
If multiple origination accounts are available, origination_account_id must be used to specify the account that the sweeps belong to.
Starting ID of sweeps to return.
int320 <= valueThe start datetime of sweeps to return (RFC 3339 format).
date-timeThe end datetime of sweeps to return (RFC 3339 format).
date-timeThe maximum number of sweeps to return.
int321 <= value <= 2525Response Body
application/json
application/json
curl -X POST "https://example.com/bank_transfer/sweep/list" \ -H "Content-Type: application/json" \ -d '{}'{ "sweeps": [ { "id": 0, "transfer_id": "460cbe92-2dcc-8eae-5ad6-b37d0ec90fd9", "created_at": "2020-08-06T17:27:15Z", "amount": "12.34", "iso_currency_code": "USD", "sweep_account": { "account_number": "123456789", "routing_number": "111111111" } } ], "request_id": "saKrIBuEB9qJZno"}