plaid

List transfer events

Changed on

Use the /transfer/event/list endpoint to get a list of transfer events based on specified filter criteria.

post/transfer/event/list

Request

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

end_datestring date-time nullable

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

transfer_idstring nullable

Plaid's unique identifier for a transfer.

account_idstring nullable

The account ID to get events for all transactions to/from an account.

transfer_type'debit' | 'credit' | 'null' nullable

The type of transfer. This will be either debit or credit. A debit indicates a transfer of money into your origination account; a credit indicates a transfer of money out of your origination account.

event_typesTransferEventType[]

Filter events by event type.

sweep_idstring

Plaid's unique identifier for a sweep.

countinteger nullable

The maximum number of transfer events to return. If the number of events matching the above parameters is greater than count, the most recent events will be returned.

offsetinteger nullable

The offset into the list of transfer events. When count=25 and offset=0, the first 25 events will be returned. When count=25 and offset=25, the next 25 events will be returned.

origination_account_idstring nullable

The origination account ID to get events for transfers from a specific origination account.

originator_client_idstring nullable

Filter transfer events to only those with the specified originator client.

funding_account_idstring nullable

Filter transfer events to only those with the specified funding_account_id.

Response

OK

has_moreboolean required

Whether there are more events to be pulled from the endpoint that have not already been returned

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

  • e07a869352e8Revision changes
    • warning

      added the new adjustment enum value to the // response property for the response status

    • info

      added the new adjustment enum value to the request property /