plaid

(Deprecated) List sweeps

Changed on

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

post/bank_transfer/sweep/list

Request

  • Base URL
    https://production.plaid.com
  • URL
    https://production.plaid.com/bank_transfer/sweep/list
  • Auth
    API key in header PLAID-CLIENT-ID and API key in header PLAID-SECRET and API key in header Plaid-Version

Request body

client_idstring

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.

secretstring

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_idstring nullable

If multiple origination accounts are available, origination_account_id must be used to specify the account that the sweeps belong to.

start_timestring date-time nullable

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

end_timestring date-time nullable

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

countinteger nullable

The maximum number of sweeps to return.

Response

OK

request_idstring required

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

Changes

  • ea443cd78f6fRevision changes
    • warning

      added the new CRA_PARTNER_INSIGHTS_ERROR enum value to the response property for the response status

    • warning

      added the new CRA_REPORT_ERROR enum value to the response property for the response status

  • 94406d9a4d27Revision changes
    • info

      endpoint deprecated