provider plaid POST /transfer/event/list
@utdk/plaid /transfer/event/list
List transfer events
Use the `/transfer/event/list` endpoint to get a list of transfer events based on specified filter criteria.

Try it

Authentication
Configure credentials for The Plaid API
transfereventlist
POST/transfer/event/list
Use the `/transfer/event/list` endpoint to get a list of transfer events based on specified filter criteria.

Input

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.

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

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

Plaid’s unique identifier for a transfer.

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

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.

Filter events by event type.

Plaid’s unique identifier for a sweep.

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.

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.

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

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

Filter transfer events to only those with the specified `funding_account_id`.

Configure credentials above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import plaid from '@utdk/plaid';

await plaid.transfereventlist({
  "count": 25,
  "offset": 0
})