plaid

List transfer ledger events

Changed on

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

post/transfer/ledger/event/list

Request

  • Base URL
    https://production.plaid.com
  • URL
    https://production.plaid.com/transfer/ledger/event/list
  • Auth
    API key in header PLAID-CLIENT-ID and API key in header PLAID-SECRET and API key in header Plaid-Version

Request body

client_idstring

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_idstring 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.)

secretstring

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_datestring 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_datestring 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_idstring nullable

Plaid's unique identifier for a Plaid Ledger Balance.

ledger_event_idstring 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_idstring nullable

Plaid's unique identifier for a transfer, sweep, or refund.

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

offsetinteger 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

OK

has_moreboolean required

Whether there are more events to be pulled from the endpoint that have not already been returned

request_idstring required

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

Changes

  • ea443cd78f6fRevision changes
    • warning

      added the new CRA_PARTNER_INSIGHTS_ERROR enum value to the response property for the response status

    • warning

      added the new CRA_REPORT_ERROR enum value to the response property for the response status

  • a1bbca018160Revision changes
    • warning

      added the new ASSETS_ERROR enum value to the response property for the response status

    • warning

      added the new CRA_MONITORING_ERROR enum value to the response property for the response status

    • warning

      added the new CREDIT_PROFILE_REPORT_ERROR enum value to the response property for the response status

    • warning

      added the new ENCOMPASS_ERROR enum value to the response property for the response status

    • warning

      added the new ENRICH_ERROR enum value to the response property for the response status

    • warning

      added the new FRAUD_INSIGHTS_ERROR enum value to the response property for the response status

    • warning

      added the new FREDDIE_MAC_ERROR enum value to the response property for the response status

    • warning

      added the new LINK_DELIVERY_ERROR enum value to the response property for the response status

    • warning

      added the new PROFILE_ERROR enum value to the response property for the response status

    • warning

      added the new RECURRING_TRANSACTIONS_ERROR enum value to the response property for the response status

    • warning

      added the new STATEMENTS_ERROR enum value to the response property for the response status

    • warning

      added the new TRANSFER_RECURRING_ERROR enum value to the response property for the response status

    • warning

      added the new TRANSFER_REFUND_ERROR enum value to the response property for the response status