Sync transfer events
POST /transfer/event/sync
/transfer/event/sync allows you to request up to the next 25 transfer events that happened after a specific event_id. Use the /transfer/event/sync endpoint to guarantee you have seen all transfer events.
Request Body
Required
Defines the request schema for /transfer/event/sync
Parameters
client_id
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.
secret
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.
after_id
The latest (largest)
event_id fetched via the sync endpoint, or 0 initially.
count
The maximum number of transfer events to return.
Response
Defines the response schema for /transfer/event/sync
Response Properties
transfer_events
event_id
Plaid’s unique identifier for this event. IDs are sequential unsigned 64-bit integers.
timestamp
The datetime when this event occurred. This will be of the form
2006-01-02T15:04:05Z.
event_type
The type of event that this transfer represents. Event types with prefix
sweep represents events for Plaid Ledger sweeps.
pending: A new transfer was created; it is in the pending state.
cancelled: The transfer was cancelled by the client.
failed: The transfer failed, no funds were moved.
posted: The transfer has been successfully submitted to the payment network.
settled: The transfer has been successfully completed by the payment network.
funds_available: Funds from the transfer have been released from hold and applied to the ledger’s available balance. (Only applicable to ACH debits.)
returned: A posted transfer was returned.
swept: The transfer was swept to / from the sweep account.
swept_settled: Credits are available to be withdrawn or debits have been deducted from the customer’s business checking account.
return_swept: Due to the transfer being returned, funds were pulled from or pushed back to the sweep account.
sweep.pending: A new ledger sweep was created; it is in the pending state.
sweep.posted: The ledger sweep has been successfully submitted to the payment network.
sweep.settled: The transaction has settled in the funding account. This means that funds withdrawn from Plaid Ledger balance have reached the funding account, or funds to be deposited into the Plaid Ledger Balance have been pulled, and the hold period has begun.
sweep.returned: A posted ledger sweep was returned.
sweep.failed: The ledger sweep failed, no funds were moved.
sweep.funds_available: Funds from the ledger sweep have been released from hold and applied to the ledger’s available balance. This is only applicable to debits.
refund.pending: A new refund was created; it is in the pending state.
refund.cancelled: The refund was cancelled.
refund.failed: The refund failed, no funds were moved.
refund.posted: The refund has been successfully submitted to the payment network.
refund.settled: The refund transaction has settled in the Plaid linked account.
refund.returned: A posted refund was returned.
refund.swept: The refund was swept from the sweep account.
refund.return_swept: Due to the refund being returned, funds were pushed back to the sweep account.
account_id
The account ID associated with the transfer. This field is omitted for Plaid Ledger Sweep events.
funding_account_id
The id of the associated funding account, available in the Plaid Dashboard. If present, this indicates which of your business checking accounts will be credited or debited.
ledger_id
Plaid’s unique identifier for a Plaid Ledger Balance.
transfer_id
Plaid’s unique identifier for a transfer. This field is an empty string for Plaid Ledger Sweep events.
origination_account_id
The ID of the origination account that this balance belongs to.
transfer_type
The type of transfer. Valid values are
debit or credit. A debit indicates a transfer of money into the origination account; a credit indicates a transfer of money out of the origination account. This field is omitted for Plaid Ledger Sweep events.
transfer_amount
The amount of the transfer (decimal string with two digits of precision e.g. “10.00”). This field is omitted for Plaid Ledger Sweep events.
failure_reason
The failure reason if the event type for a transfer is
"failed" or "returned". Null value otherwise.
failure_code
The failure code, e.g.
R01. A failure code will be provided if and only if the transfer status is returned. See ACH return codes for a full listing of ACH return codes and RTP/RfP error codes for RTP error codes.
ach_return_code
The ACH return code, e.g.
R01. A return code will be provided if and only if the transfer status is returned. For a full listing of ACH return codes, see Transfer errors.
description
A human-readable description of the reason for the failure or reversal.
sweep_id
Plaid’s unique identifier for a sweep.
sweep_amount
A signed amount of how much was
swept or return_swept for this transfer (decimal string with two digits of precision e.g. “-5.50”).
refund_id
Plaid’s unique identifier for a refund. A non-null value indicates the event is for the associated refund of the transfer.
originator_client_id
The Plaid client ID that is the originator of the transfer that this event applies to. Only present if the transfer was created on behalf of another client as a third-party sender (TPS).
intent_id
The
id returned by the /transfer/intent/create endpoint, for transfers created via Transfer UI. For transfers not created by Transfer UI, the value is null. This will currently only be populated for RfP transfers.
wire_return_fee
The fee amount deducted from the original transfer during a wire return, if applicable.
has_more
Whether there are more events to be pulled from the endpoint that have not already been returned
request_id
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.