PaymentMadeEvent

Event emitted by BriteCore (BritecorePaymentMade.v1).

Payload schema

Code
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://docs.britecore.com/schemas/events/payment_made.json",
  "title": "PaymentMadeEvent",
  "type": "object",
  "properties": {
    "event_id": {
      "type": "string",
      "format": "uuid",
      "description": "Unique identifier for this event instance."
    },
    "event_date": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp the event was emitted (UTC)."
    },
    "schema_id": {
      "type": "string",
      "description": "Schema identifier. Stable per event type.",
      "const": "BritecorePaymentMade.v1"
    },
    "version": {
      "type": "string",
      "description": "Schema version.",
      "const": "1.0.0"
    },
    "topic": {
      "type": "string",
      "description": "Topic the event was published on."
    },
    "triggering_user": {
      "type": "object",
      "description": "User that triggered the event.",
      "properties": {
        "id": {
          "type": "string"
        },
        "external_system_reference": {
          "type": "string"
        }
      }
    },
    "data": {
      "type": "object",
      "properties": {
        "policy_id": {
          "type": "integer"
        },
        "policy_number": {
          "type": "string"
        },
        "payment_id": {
          "type": "integer"
        },
        "invoices_changed": {
          "type": "string"
        },
        "payment_date": {
          "type": "string",
          "format": "date-time"
        },
        "vendor_reference_id": {
          "type": "integer"
        },
        "payment_confirmation_number": {
          "type": "string"
        },
        "payment_status": {
          "type": "string"
        },
        "contact_id": {
          "type": "integer"
        },
        "contact_external_system_reference": {
          "type": "string"
        },
        "revision_external_system_reference": {
          "type": "string"
        }
      },
      "required": [
        "policy_id",
        "policy_number",
        "payment_id",
        "invoices_changed",
        "payment_date",
        "vendor_reference_id",
        "payment_confirmation_number",
        "payment_status"
      ]
    }
  },
  "required": [
    "event_id",
    "event_date",
    "schema_id",
    "version",
    "topic",
    "data"
  ]
}

The schema is also published as a standalone JSON Schema artefact you can fetch and consume programmatically. See schemas/events/payment_made.json on the published portal.

Example payload

Code
{
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_date": "2026-01-01T00:00:00Z",
  "schema_id": "BritecorePaymentMade.v1",
  "version": "1.0.0",
  "topic": "policies.payment_made",
  "data": {
    "policy_id": 0,
    "policy_number": "string",
    "payment_id": 0,
    "invoices_changed": "string",
    "payment_date": "2026-01-01T00:00:00Z",
    "vendor_reference_id": 0,
    "payment_confirmation_number": "string",
    "payment_status": "string",
    "contact_id": 0,
    "contact_external_system_reference": "string",
    "revision_external_system_reference": "string"
  }
}

Notes