plaid

Webhook receiver for fdx notifications

Changed on

A generic webhook receiver endpoint for FDX Event Notifications

post/fdx/notifications

Request

  • Base URL
    https://production.plaid.com
  • URL
    https://production.plaid.com/fdx/notifications
  • Auth
    API key in header PLAID-CLIENT-ID and API key in header PLAID-SECRET and API key in header Plaid-Version

Request body

notificationIdstring required

Id of notification

type'ACCOUNT_TAKEOVER' | 'ADDRESS_CHANGED' | 'BALANCE' | 'CONSENT_EXPIRED' | 'CONSENT_GRANTED' | 'CONSENT_REVOKED' | 'CONSENT_UPDATED' | 'CUSTOM' | 'MFA_TARGET_CHANGED' | 'PHONE_CHANGED' | 'PLANNED_OUTAGE' | 'RISK' | 'SERVICE' | 'SUSPECTED_INCIDENT' | 'TAN_ACTIVATED' | 'TAN_CREATED' | 'TAN_REVOKED' | 'TAN_SUSPENDED' required

Type of Notification

subtypestring

An optional initiator-defined event subtype code or description if the event type needs to be further categorized or described.

sentOnstring date-time required

ISO 8601 date-time in format 'YYYY-MM-DDThh:mm:ss.nnn[Z|[+|-]hh:mm]' according to IETF RFC3339

category'SECURITY' | 'MAINTENANCE' | 'FRAUD' | 'CONSENT' | 'NEW_DATA' | 'TOKENIZED_ACCOUNT_NUMBER' required

Category of Notification

severity'EMERGENCY' | 'ALERT' | 'WARNING' | 'NOTICE' | 'INFO'

Severity level of notification

priority'HIGH' | 'MEDIUM' | 'LOW'

Priority of notification

Example request

{
  "sentOn": "2021-07-15T14:46:41.375Z",
  "notificationPayload": {
    "event": {
      "updatedTime": "2021-07-15T14:46:41.375Z"
    }
  },
  "url": {
    "href": "https://api.fi.com/fdx/v4/accounts/12345"
  }
}

Response

OK

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