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

Required

Defines the request schema for /transfer/ledger/event/list

Parameters

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
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
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
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
Plaid’s unique identifier for a Plaid Ledger Balance.
ledger_event_id
string
Plaid’s unique identifier for the ledger event.
source_type
string
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
Plaid’s unique identifier for a transfer, sweep, or refund.
count
integer
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
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

Defines the response schema for /transfer/ledger/event/list

Response Properties

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