plaid

(Deprecated) List bank transfers

Changed on

Use the /bank_transfer/list endpoint to see a list of all your bank transfers and their statuses. Results are paginated; use the count and offset query parameters to retrieve the desired bank transfers.

post/bank_transfer/list

Request

  • Base URL
    https://production.plaid.com
  • URL
    https://production.plaid.com/bank_transfer/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 datetime of bank transfers to list. This should be in RFC 3339 format (i.e. 2019-12-06T22:35:49Z)

end_datestring date-time nullable

The end datetime of bank transfers to list. This should be in RFC 3339 format (i.e. 2019-12-06T22:35:49Z)

countinteger

The maximum number of bank transfers to return.

offsetinteger

The number of bank transfers to skip before returning results.

origination_account_idstring nullable

Filter bank transfers to only those originated through the specified origination account.

direction'outbound' | 'inbound' | 'null' nullable

Indicates the direction of the transfer: outbound for API-initiated transfers, or inbound for payments received by the FBO account.

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