client-update

Summary

A client’s surname has been updated in Sirius

Context

As Allpay uses the client’s surname as an identifier for mandates, we need to update the value in Allpay when the surname
is updated in Sirius. The event has been structured to allow for future updates to other client details, if required.

Trigger

A client’s surname is updated.

Effect

Allpay is updated with the new surname, ensuring that future Direct Debit interactions are successful.

Examples

{
  "clientId": 1,
  "surname": {
    "old": "Oldman",
    "new": "Newson"
  }
}

Schema

{
  "$id": "https://opg.service.justice.gov.uk/opg.supervision.sirius/client-created.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "opg.supervision.sirius/client-updated",
  "type": "object",
  "properties": {
    "clientId": {
      "type": "integer",
      "description": "The client's ID"
    },
    "surname": {
      "type": "object",
      "required": ["old", "new"],
      "properties": {
        "old": {
          "type": "string",
          "description": "The client's old surname"
        },
        "new": {
          "type": "string",
          "description": "The client's new surname"
        }
      }
    }
  },
  "required": [
    "clientId",
    "surname"
  ]
}

Event Flow