You've Been Paid (youveBeenPaid)

Id: youveBeenPaid

An event that notifies that the user has been paid their salary (must be > £600) into one of their cash accounts. The notification is generated when the system detects salary transactions within both the past 7 days and also +/- 7 days from the same date a month ago (with some differences in timescales in December/January to account for Christmas payments tending to be earlier).

When it is sent

• Most recent transaction in cash account with a category of "salary" and value of over £600 is no more than 7 days old
• At least one other salary transaction (a category of "salary" in a cash account with a value of over £600) is present +/- 7 days from the current day (e.g. 23rd) in the previous month
• Requires at least 2 matching salaries (current + 1 previous)
• If the current date is between 23rd Jan and 31st Jan then the salary entry for the previous month can be up to 14 days earlier than the current day of the month but still 7 days later (e.g. for 23rd Jan can be as early as 9th Dec but only as late as 30th Dec)
• If the current date is between 15th Dec and 23rd Dec then the salary entry for the previous month can be up to 14 days later than the current day of the month but still 7 days before (e.g. for 15th Dec can be as late as 29th Nov but only as early as 8th Nov)

Payload

These fields are sent in the payload object of the webhook envelope. Fields without a value are left out.

Example (JSON format)

{
  "id": "abe168ce-1b2f-4c38-9c92-db5730485cb3",
  "eventType": "youveBeenPaid",
  "userId": "5c79210bbac25ecb5e71ac40",
  "payload": {
    "accountId": "6d0baf11-248e-4c11-9c04-97b7758b4e04",
    "transactionId": "d520402a-d982-43ee-b1d1-bdfd282249ea",
    "transactionDate": "2023-11-30T17:19:42Z",
    "amount": 3480.02
  }
}

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.