POST /transfer/ledger/event/list

Use the /transfer/ledger/event/list endpoint to get a list of ledger events for a specific ledger 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
`source_id`	String	No	Plaid's unique identifier for a transfer, sweep, or refund.
`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
`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)
`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.
`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)
`source_type`	String	No	Source of the ledger event. `"TRANSFER"` - The source of the ledger event is a transfer `"SWEEP"` - The source of the ledger event is a sweep `"REFUND"` - The source of the ledger event is a refund Valid values: `"TRANSFER"` `"SWEEP"` `"REFUND"`
`ledger_id`	String	No	Plaid's unique identifier for a Plaid Ledger Balance.
`ledger_event_id`	String	No	Plaid's unique identifier for the ledger event.
`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.
`originator_client_id`	String	No	Filter transfer events to only those with the specified originator client. (This field is specifically for resellers. Caller's client ID will be used if this field is not specified.)
`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

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.