plaid

List sweeps

Changed on

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

post/transfer/sweep/list

Request

  • Base URL
    https://production.plaid.com
  • URL
    https://production.plaid.com/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.

start_datestring date-time nullable

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

end_datestring date-time nullable

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

countinteger nullable

The maximum number of sweeps to return.

offsetinteger

The number of sweeps to skip before returning results.

amountstring nullable

Filter sweeps to only those with the specified amount.

status'pending' | 'posted' | 'settled' | 'funds_available' | 'returned' | 'failed' | 'null' nullable

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.

originator_client_idstring nullable

Filter sweeps to only those with the specified originator client.

funding_account_idstring nullable

Filter sweeps to only those with the specified funding_account_id.

transfer_idstring nullable

Filter sweeps to only those with the included transfer_id.

trigger'manual' | 'incoming' | 'balance_threshold' | 'automatic_aggregate' nullable

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.

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

  • a1bbca018160Revision changes
    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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