direct-debit-collection

Summary

A Direct Debit collection has been scheduled for a client

Context

On scheduling a collection for a Direct Debit, Sirius needs to send a letter to the client confirming the collection details.

Trigger

A Direct Debit payment collection is scheduled for a client.

Effect

Sirius Supervision creates a Direct Debit collection confirmation letter to the client.

Examples

{
  "clientId": 1,
  "amount": 1000,
  "collectionDate": "2024-06-15T00:00:00Z"
}

Schema

{
  "$id": "https://opg.service.justice.gov.uk/opg.supervision.sirius/direct-debit-collection.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "opg.supervision.sirius/direct-debit-collection",
  "type": "object",
  "properties": {
    "clientId": {
      "type": "integer",
      "description": "The client's ID"
    },
    "amount": {
      "type": "integer",
      "description": "The collection amount in pence"
    },
    "collectionDate": {
      "type": "string",
      "description": "The collection date in YYYY-MM-DDTHH:MM:SS format"
    }
  },
  "required": [
    "clientId",
    "amount",
    "collectionDate"
  ]
}

Event Flow