Plaid logo
Docs
ALL DOCS

Bank Transfers

  • Introduction to Bank Transfers
  • Idempotency and Retries
  • Webhooks in Bank Transfers
  • API Reference
Plaid logo
Docs
Close search modal
Ask Bill!
Ask Bill!
Hi! I'm Bill! You can ask me all about the Plaid API. Try asking questions like:
    Note: Bill isn't perfect. He's just a robot platypus that reads our docs for fun. You should treat his answers with the same healthy skepticism you might treat any other answer on the internet. This chat may be logged for quality and training purposes. Please don't send Bill any PII -- he's scared of intimacy. All chats with Bill are subject to Plaid's Privacy Policy.
    Plaid.com
    Log in
    Get API Keys
    Open nav

    Webhooks in Bank Transfers

    Learn how to use webhooks in Bank Transfers to receive notifications when new events are available

    Enabling Bank Transfers 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 Bank Transfers 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.

    Webhook body

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

    1{
    2 "webhook_type": "BANK_TRANSFERS",
    3 "webhook_code": "BANK_TRANSFERS_EVENTS_UPDATE"
    4}

    Example integration

    Upon receiving a BANK_TRANSFERS_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 Bank 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.BankTransferEventSync(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);
    Was this helpful?
    Developer community
    GitHub
    GitHub
    Stack Overflow
    Stack Overflow
    YouTube
    YouTube
    Discord
    Discord