POST /transfer/event/list

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

Servers

https://production.plaid.com
https://sandbox.plaid.com

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`transfer_id`	String	No	Plaid’s unique identifier for a transfer.
`count`	Integer	No	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. Default value: 25
`client_id`	String	No	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.
`event_types[]`	Array	No	Filter events by event type.
`sweep_id`	String	No	Plaid’s unique identifier for a sweep.
`start_date`	String	No	The start `created` datetime of transfers to list. This should be in RFC 3339 format (i.e. `2019-12-06T22:35:49Z`)
`end_date`	String	No	The end `created` datetime of transfers to list. This should be in RFC 3339 format (i.e. `2019-12-06T22:35:49Z`)
`transfer_type`	String	No	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. Possible values: `"credit"` `null` `"debit"`
`origination_account_id`	String	No	The origination account ID to get events for transfers from a specific origination account.
`funding_account_id`	String	No	Filter transfer events to only those with the specified `funding_account_id`.
`account_id`	String	No	The account ID to get events for all transactions to/from an account.
`secret`	String	No	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.
`offset`	Integer	No	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. Default value: 0
`originator_client_id`	String	No	Filter transfer events to only those with the specified originator client.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.