Transfer webhooks

An overview of webhooks at Plaid is available in the API Reference. There you can find general information on Plaid webhooks, including IP addresses, webhook verification, and retry logic.

To enable Transfer webhooks, add your endpoint on the account webhooks page of the dashboard. If you are not able to access the page, contact your Plaid Account Manager.

To confirm that your endpoint has been correctly configured, you can trigger a test webhook via /sandbox/transfer/fire_webhook. You should receive the payload body specified below.

1{
2  "webhook_type": "TRANSFER",
3  "webhook_code": "TRANSFER_EVENTS_UPDATE"
4}

Upon receiving a TRANSFER_EVENTS_UPDATE webhook, poll the events sync endpoint to process the available events. Note that there may only be one new event, or there may be many new events. Plaid will send a maximum of approximately 1 webhook per minute as new events continue to become available, unless you are using Transfer webhooks for micro-deposit event notifications, in which case you will receive a separate webhook for each event.

1// Webhook received
2wait_for_and_ack_webhook();
3// Fetch the maximum event ID from your systems
4after_id = fetch_last_event_id();
5var events = [];
6
7// Poll event sync endpoint for all new events
8do {
9  // Fetch the next set of events and update after_id
10  events = plaidClient.transferEventSync(after_id);
11  after_id += len(events);
12
13  // Handle new events
14  for (event of events) {
15    yourEventHandler(event);
16  }
17} while (events.length > 0);

For a real-life example of an app that incorporates the transfer webhook and tests it using the sandbox/transfer/fire_webhook endpoint, see the Node-based Plaid Pattern Transfer sample app. Pattern Transfer is a sample subscriptions payment app that enables ACH bank transfers. The Transfer webhook handler can be found in handleTransferWebhook.js and the test which fires the webhook can be found at events.js