---
title: "List transfer ledger events"
method: POST
path: "/transfer/ledger/event/list"
tags: ["plaid"]
---

# List transfer ledger events

`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.

## Request body

- TransferLedgerEventListRequest — Defines the request schema for `/transfer/ledger/event/list`
  - `client_id` string — 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.
  - `originator_client_id` string, nullable — 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.)
  - `secret` string — 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_date` string, 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_date` string, 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)
  - `ledger_id` string, nullable — Plaid's unique identifier for a Plaid Ledger Balance.
  - `ledger_event_id` string, nullable — Plaid's unique identifier for the ledger event.
  - `source_type` 'TRANSFER' | 'SWEEP' | 'REFUND', nullable — 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
  - `source_id` string, nullable — Plaid's unique identifier for a transfer, sweep, or refund.
  - `count` integer, 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.
  - `offset` integer, 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.

## Response `200`

OK

- TransferLedgerEventListResponse — Defines the response schema for `/transfer/ledger/event/list`
  - `ledger_events` TransferLedgerEvent[], required
    - `ledger_event_id` string, required — Plaid's unique identifier for this ledger event.
    - `ledger_id` string, required — The ID of the ledger this event belongs to.
    - `amount` string, required — The amount of the ledger event as a decimal string.
    - `transfer_id` string, nullable — The ID of the transfer source that triggered this ledger event.
    - `refund_id` string, nullable — The ID of the refund source that triggered this ledger event.
    - `sweep_id` string, nullable — The ID of the sweep source that triggered this ledger event.
    - `description` string, required — A description of the ledger event.
    - `pending_balance` string, required — The new pending balance after this event.
    - `available_balance` string, required — The new available balance after this event.
    - `type` string, required — The type of balance that was impacted by this event.
    - `timestamp` string, date-time, required — The datetime when this ledger event occurred.
  - `has_more` boolean, required — Whether there are more events to be pulled from the endpoint that have not already been returned
  - `request_id` string, required — A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

## Other responses

- `default` — Error response

---

[API](https://skmtc.net/plaid/apis/the-plaid-api.md) · [All operations](https://skmtc.net/plaid/apis/the-plaid-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/plaid/the-plaid-api/revisions/64c4514ea59b/schema)