All exchanges with the Terminal Management System (TMS) are initiated by the Point of Interaction (POI) sending a Status Report.

The intended flow is for a POI to send a StatusReport requesting a ManagementPlanReplacement and, if updates are needed, send another StatusReport requesting an AcceptorConfigurationUpdate . Optionally, the POI can send another StatusReport checking for further changes.

URL: /v1/catm/status-report

HTTP verb: POST

Use ISO20022 message definition StatusReportV12 (message identifier: catm.001.001.12).

It is recommended to use the ISO 20022 Dictionary to determine the complete structure of the message: https://www.iso20022.org/standardsrepository/type/StatusReportV12

We support two ways of using a StatusReport: 1. To request a ManagementPlanReplacement detailing actions the POI must take to align its configuration with the TMS' expectations. 2. To request an AcceptorConfigurationUpdate containing the necessary configuration parameters.

The intended flow is for a POI to send a StatusReport requesting a ManagementPlanReplacement and, if updates are needed, send another StatusReport requesting an AcceptorConfigurationUpdate .

Please note the following additional requirements:

If the request could not be successfully processed, a TerminalManagementRejection message will be returned.

Otherwise, there are two scenarios:

The StatusReport can request a ManagementPlanReplacement (message identifier: catm.002.001.12) by setting DataSet.Content.DataSetRequired[0].Identification.Type to "ManagementPlan". A ManagementPlanReplacement message will be returned to inform the POI of any changes that need to be made. Conceptually the POI starts with a 'management plan' of doing nothing, and this is 'replaced' with, for example, 'update the firmware to version X and perform remote key loading'. In the integration environment, for ease of testing we always indicate that the POI must download a dataset with Name 'RKI' and Type 'SecurityParameters'.

The StatusReport can request an AcceptorConfigurationUpdate (message identifier: catm.003.001.12) containing security parameters by setting DataSet.Content.DataSetRequired[0].Identification.Type to "SecurityParameters". The TMS will respond with keys and other security material in a format agreed with the integrator (outside the scope of this document).

Please note that a SecurityTrailer of type ContentInformationType33 will always be included with the response to allow the Acceptor to verify that the response is legitimate.

The messages provided below are formatted for readability. When sending requests to the gateway, the request body should be compacted by removing all non-significant whitespace characters.