Reconciling Transfers

You can use the /transfer/event/sync endpoint to retrieve all of the events and statuses associated with your transfers. This is useful when performing reconciliation, as it guarantees that you've seen all transfer events. The main identifier for Plaid transfers is the transfer_id. You should plan to store this identifier to help facilitate transfer reconciliation.

• Create a cron job in your system to run periodically (recommended every 1 hour)

First, retrieve the event_id that was seen the last time you ran the cron job from your datastore.

after_id = yourDatabase.get("after_id")
events = new Array(BankTransferEvent)

Next, call the /transfer/event/sync endpoint with that event_id and persist the returned events in your datastore. Continue calling the /transfer/event/sync endpoint, passing in the event_id from the previous call until the response has zero results.

# Start at the last event ID received
after_id = yourDatabase.get("after_id")
events = new Array(BankTransferEvent)
# Poll event sync endpoint until there are no more new events
do {
  # Fetch the next set of events and update after_id
  events = plaidClient.BankTransferEventSync(after_id)
  after_id += len(events)
  # Handle any new events
  for event in events {
    # Store ID, event type (e.g. pending, posted, failed, canceled), timestamp
    yourDatabase.set(event.bank_transfer_id, event.event_type, event.timestamp}
} while (!events.Empty());

Finally, persist that last event_id in your datastore to use the next time you perform this process.

yourDatabase.set("after_id", after_id)

A single transfer will have more than one event associated with it. For example, a successful transfer’s status will initially start out as pending before it’s sent to the ACH network, then move to posted when the funds are available in the account. Each of these status updates will return a unique event from the /transfer/event/sync endpoint, so, in this example, you’ll see two events for this particular transfer_id throughout its lifespan.

Listed below are the event transitions you will see as a transfer progresses through its lifespan.