Documentation for a newer release is available. View Latest

List of System Events

The below table documents the system events that can be raised by SEPA DD CSM. Payload schemas are documented as JSON Schema draft 4. Use a tool such as this one for a visual representation of the payload schemas.

All events contain some basic top-level information, and a payload. The top-level information is represented as members of the IPFSystemEvent type, and their payloads are documented below.

The schema for the top-level IPFSystemEvent type is as follows:

Top-level Schema 
{
  "$schema" : "http://json-schema.org/draft-04/schema#",
  "title" : "IPF System Event",
  "type" : "object",
  "additionalProperties" : false,
  "properties" : {
    "name" : {
      "type" : "string"
    },
    "level" : {
      "type" : "string",
      "enum" : [ "DEBUG", "INFO", "WARN", "ERROR" ]
    },
    "createdAt" : { },
    "version" : {
      "$ref" : "#/definitions/EventVersion"
    },
    "type" : {
      "type" : "string",
      "enum" : [ "TECHNICAL", "FUNCTIONAL" ]
    },
    "processingContext" : {
      "$ref" : "#/definitions/ProcessingContext"
    },
    "source" : {
      "type" : "string"
    },
    "metadata" : {
      "type" : "object",
      "additionalProperties" : {
        "type" : "string"
      }
    },
    "payload" : {
      "$ref" : "#/definitions/Object"
    }
  },
  "definitions" : {
    "EventVersion" : {
      "type" : "object",
      "additionalProperties" : false,
      "properties" : {
        "major" : {
          "type" : "integer"
        },
        "minor" : {
          "type" : "integer"
        },
        "patch" : {
          "type" : "integer"
        }
      },
      "required" : [ "major", "minor", "patch" ]
    },
    "ProcessingContext" : {
      "type" : "object",
      "additionalProperties" : false,
      "properties" : {
        "associationId" : {
          "type" : "string"
        },
        "checkpoint" : {
          "type" : "string"
        },
        "unitOfWorkId" : {
          "type" : "string"
        },
        "clientRequestId" : {
          "type" : "string"
        },
        "processingEntity" : {
          "type" : "string"
        }
      }
    },
    "Object" : {
      "type" : "object",
      "additionalProperties" : false,
      "properties" : { }
    }
  }
}

SEPA DD CSM System Events

Name Description Type Level Payload schema

BulkCommandFailed

Published when a command to the recurring bulk fails

TECHNICAL

ERROR

 
{
  "$schema" : "http://json-schema.org/draft-04/schema#",
  "title" : "Payload",
  "type" : "object",
  "additionalProperties" : false,
  "properties" : {
    "errorMessage" : {
      "type" : "string"
    },
    "componentContent" : {
      "type" : "string"
    }
  }
}

FileRejected

Published when a File is rejected by the STEP2 Scheme

FUNCTIONAL

ERROR

 
{
  "$schema" : "http://json-schema.org/draft-04/schema#",
  "title" : "Simple Event Payload",
  "type" : "object",
  "additionalProperties" : false,
  "properties" : {
    "description" : {
      "type" : "string"
    }
  }
}

MDSEmissionFailed

Published when unable to emit an MDS to link objects in ODS

FUNCTIONAL

ERROR

 
{
  "$schema" : "http://json-schema.org/draft-04/schema#",
  "title" : "Simple Event Payload",
  "type" : "object",
  "additionalProperties" : false,
  "properties" : {
    "description" : {
      "type" : "string"
    }
  }
}

PaymentStatusReportGenerationFailed

Published when an error occurs while generating a payment status report - pacs.002

TECHNICAL

ERROR

 
{
  "$schema" : "http://json-schema.org/draft-04/schema#",
  "title" : "Simple Event Payload",
  "type" : "object",
  "additionalProperties" : false,
  "properties" : {
    "description" : {
      "type" : "string"
    }
  }
}

PaymentStatusReportRejected

Published when a payment status report is rejected due to an invalid bulk file

TECHNICAL

ERROR

 
{
  "$schema" : "http://json-schema.org/draft-04/schema#",
  "title" : "Payload",
  "type" : "object",
  "additionalProperties" : false,
  "properties" : {
    "message" : {
      "type" : "string"
    }
  }
}

ReceiveFromSchemeExtensionPointFailed

Published when a negative response is received from scheme message level extension point

FUNCTIONAL

ERROR

 
{
  "$schema" : "http://json-schema.org/draft-04/schema#",
  "title" : "Simple Event Payload",
  "type" : "object",
  "additionalProperties" : false,
  "properties" : {
    "description" : {
      "type" : "string"
    }
  }
}

RegisterBulkCorrelationFailed

Published when registering a bulk correlation fails

TECHNICAL

ERROR

 
{
  "$schema" : "http://json-schema.org/draft-04/schema#",
  "title" : "Payload",
  "type" : "object",
  "additionalProperties" : false,
  "properties" : {
    "errorMessage" : {
      "type" : "string"
    },
    "correlation" : {
      "type" : "string"
    },
    "transaction" : {
      "type" : "string"
    }
  }
}

SendToSchemeExtensionPointFailed

Published when a negative response is received from a send to scheme message level extension point

FUNCTIONAL

ERROR

 
{
  "$schema" : "http://json-schema.org/draft-04/schema#",
  "title" : "Simple Event Payload",
  "type" : "object",
  "additionalProperties" : false,
  "properties" : {
    "description" : {
      "type" : "string"
    }
  }
}

SendToSchemeExtensionPointSuccess

Published when a successful response is received from a send to scheme message level extension point

FUNCTIONAL

DEBUG

 
{
  "$schema" : "http://json-schema.org/draft-04/schema#",
  "title" : "Simple Event Payload",
  "type" : "object",
  "additionalProperties" : false,
  "properties" : {
    "description" : {
      "type" : "string"
    }
  }
}

SendingSchemeResponseFailed

Published when the Debulked Component Handler does not complete successfully

FUNCTIONAL

ERROR

 
{
  "$schema" : "http://json-schema.org/draft-04/schema#",
  "title" : "Simple Event Payload",
  "type" : "object",
  "additionalProperties" : false,
  "properties" : {
    "description" : {
      "type" : "string"
    }
  }
}