Body Required

• action string Required

  Action performed (balance_updated)

• createdAt string Required

  Activity creation timestamp (RFC3339)

• edges object Required
  Hide edges attribute Show edges attribute object

  • user object Required

    User information in webhook payload

    Hide user attributes Show user attributes object

    • email string Required

      User email address

    • firstName string

      User first name

    • id integer Required

      User identifier

    • lastName string

      User last name

    • status string

      User status

    • timeZone string

      User timezone

    • totpEnabled boolean

      Whether 2FA is enabled

    • userType string

      Type: personal or business

• entity string Required

  Entity type (balance)

• id integer Required

  Unique activity identifier

• payload object Required
  Hide payload attribute Show payload attribute object

  • balance object Required

    Balance information in webhook payload

    Hide balance attributes Show balance attributes object

    • amount integer Required

      Balance amount (in smallest currency unit)

    • createdAt string

      Balance creation timestamp

    • edges object
      Hide edges attributes Show edges attributes object

      • account object

        Account information in balance webhook

        Hide account attributes Show account attributes object

        • alias string

          User-defined alias

        • code string

          Internal account code

        • createdAt string

          Account creation timestamp

        • id integer Required

          Account identifier

        • name string

          Account holder name

        • status string

          Account status

        • type string Required

          Account type code

        • updatedAt string

          Account update timestamp

      • transfer object

        Transfer information in webhook payload

        Hide transfer attributes Show transfer attributes object

        • amount integer Required

          Transfer amount

        • createdAt string

          Transfer creation timestamp

        • description string

          Transfer description

        • direction string Required

          debit or credit

        • edges object
          Hide edges attribute Show edges attribute object

          • transaction object

            Transaction information in webhook payload

            Hide transaction attributes Show transaction attributes object

            • createdAt string

              Transaction creation timestamp

            • hash string

              Transaction hash

            • id integer Required

              Transaction identifier

            • status string Required

              Transaction status

            • updatedAt string

              Transaction update timestamp

        • fee_amount integer

          Fee charged

        • id integer Required

          Transfer identifier

        • purpose string

          Purpose of transfer

        • type string Required

          Transfer type: spot, etc.

        • updatedAt string

          Transfer update timestamp

    • id integer Required

      Balance record identifier

    • updatedAt string

      Balance update timestamp

• read boolean

  Whether marked as read

• updatedAt string

  Last update timestamp (RFC3339)