New and Updated Regular Transactions

The newRegularTransactions and updatedRegularTransactions events, sent when regular transaction series are detected or change.

Id: newRegularTransactions and updatedRegularTransactions

Regular Transaction webhooks are events that notify clients when enrichment has detected new regular transactions or detected changes and has updated existing ones. Enrichment is run on authorisation for supported account types, then daily thereafter.

Prerequisites

  • The API client must have the regular_transactions:read scope.

Payload

These fields are sent in the payload object of the webhook envelope.

NameTypeDescription
seriesIdsarrayArray of new or updated series ids

Example (JSON format)

{
  "id": "abe168ce-1b2f-4c38-9c92-db5730485cb3",
  "eventType": "newRegularTransactions",
  "userId": "5c79210bbac25ecb5e71ac40",
  "payload": {
    "seriesIds": [
      "032378eb-e335-5919-8f75-d833a5e4bff9"
    ]
  }
}

updatedRegularTransactions has the same shape, with eventType set to updatedRegularTransactions.

This example uses the JSON format. JWT webhooks carry the same payload fields in a different envelope, and batched webhooks list events without payloads. See Webhook Format.

Related


What’s Next

Have a look at all the detail of what is available to you about a user's regular transactions