Camt.056.001.05/Camt.056.001.08 Mapper

Overview

The Camt.056.001.05/Camt.056.001.08 (Camt.056) mappers are used by TCH for sending and receiving:
  • The cancellation of a Credit Transfer (pacs.008) or Request for Payment (pain.013) message(FIToFIPmtCxlReq) between TCH Real-Time Payment System(RTP) and FTM for Immediate Payments due to a System time-out or Request for Payment expiration at the Creditor FI.
  • Request for Return of Funds(FIToFIPmtCxlReq) between TCH Real-Time Payment System(RTP) and FTM for Immediate Payments.
The Camt.056 mappers are a pair of Inbound/Outbound mappers.
  • Camt.056 Inbound Mapper: Map the TCH System Time-out/Request for Return of Funds messages to ISF messages. The default mapper name is Camt056ToISFMapper.
  • Camt.056 Outbound Mapper: Map the ISF messages to TCH System Time-out/Request for Return of Funds messages. The default mapper name is ISFToCamt056Mapper.

The details of the mapping specification for the inbound mapper are included in a separate document. Refer to Detailed camt.056 mapping specification for more information about obtaining the documentation for the mapping specifications.

The inbound and outbound camt.056 mappers can also be used in conjunction with the Wrapper mapper, or the Business Application Header mapper. Refer to TCH Wrapper Mapper and TCH Business Application Header Mapper for more information.

Inbound Mapper

The CONFIG=entry in Channel parameter is required for inbound mapper. The mapper uses the setting to locate <msgTypeCfg> entry in Value table with child element <Type> containing camt.056.*. The <msgTypeCfg> contains the configuration parameters for the inbound mapper.

For example, the default Request From CSM channel is configured with a CONFIG=IP_MAP_CFG_REQ_FROM_CSM parameter. When a camt.056.001.05 message is received , the mapper looks for the <msgTypeCfg> entry in the Value table with the following conditions:
  • In Value table, the value of Category is IP_MAP_CFG_REQ_FROM_CSM.
  • In msgTypeCfg entry, the value of Type is camt.056.*.
The default <msgTypeCfg> for IP_MAP_CFG_REQ_FROM_CSM is as follows.
<msgTypeCfg>
	<class>CAMT056</class>
	<subType>IP_FROM_CSM_RCL</subType>
	<extendedCfg>
		<name>MASTER_FLAG</name>
		<value>Y</value>
	</extendedCfg>
	<extendedCfg>
		<name>SUBTYPE_pain.013.001.07</name>
		<value>IP_FROM_CSM_RFP_CANCEL</value>
	</extendedCfg>
	<pt>
		<class>CAMT056</class>
		<subType>IP_FROM_CSM_RCL</subType>
	</pt>
	<mapName>Camt056ToISFMapper</mapName>
	<type>camt.056.*</type>
</msgTypeCfg>
The inbound mapper uses the <msgTypeCfg> entry as follows:
  • <class> - value for TXN_PAYMENT_V.OBJ_CLASS
  • <subType> - value for TXN_PAYMENT_V.SUBTYPE and ISFMessage/Header/BusinessConcept
  • <extendedCfg>.<value> with <name>=MASTER_FLAG - value for MASTER_FLAG (for TXN_PAYMENT_V and TRANSMISSION_V)
  • <extendedCfg>.<value> with <name>=SUBTYPE_pain.013.001.07 - when the OrgnlMsgNmId in the camt.056 message is pain.013.001.07, the <subType> is replaced by the <extendedCfg>.<value>
  • <pt>.<class> - value for TRANSMISSION_V.OBJ_CLASS
  • <pt>.<subType> - value for TRANSMISSION_V.SUBTYPE

If the <msgTypeCfg> entry cannot be located, the mapper throws an exception with error 'subType not found'.

Note: The inbound mapper uses the same channel and msgTypeCfg entry for both System Time-out and Request for Return of Funds messages. At run-time, if the camt.056 message is identified as the message for System Time-out(based on the TxInf/CxlRsnInf/Rsn/Cd field), the inbound mapper updates the value of subType to IP_FROM_CSM_PCR.
Note: When the inbound mapper is used in conjunction with the Business Application Header mapper, the inbound mapper checks the value of AppHdr/CpyDplct in Business Application Header. If the value is 'DUPL', the mapper appends '_RPT' to existing <subType> value to indicate the message is a repeat request.
Table 1 shows the default configuration parameters for the channels using camt.056 inbound mapper.
Table 1. Default configuration parameters for channels using camt.056 inbound mapper
Category Class SubType MASTER_FLAG Pt.class Pt.subType
IP_MAP_CFG_REQ_FROM_CSM CAMT056 IP_FROM_CSM_RCL Y CAMT056 IP_FROM_CSM_RCL
IP_MAP_CFG_REQ_FROM_CHAN CAMT056 IP_FROM_DBTR_RCL Y CAMT056 IP_FROM_DBTR_RCL
The inbound mapper handles the Datetime elements with the rules as follows.
  • If a timezone offset is included in the datetime value, the datetime value is mapped to ISF with UTC timezone.
  • If a timezone off set is not included in a datetime value,
    • if the Timezone is configured in the Channel table, the input datetime is recognized as the value in the format of the channel timezone, and is mapped to ISF with UTC timezone.
    • if the Timezone is not configured in the Channel table, the input datetime is recognized as the value in the format of the local timezone in which the mapper is executing, and the input datetime is mapped to ISF with UTC timezone.

Outbound Mapper

The CONFIG=entry in Channel parameter is required for outbound mapper. The mapper uses the setting to locate <msgTypeCfg> entry in Value table with child element <subType> containing the same value as the ISF Business Concept. The <msgTypeCfg> contains the configuration parameters for the outbound mapper.

When the outbound mapper is used in conjunction with the Wrapper mapper, or the Business Application Header mapper, the mapper uses the setting stored in Environment.PMP.Variables.Rules.*[1].MAP_CONFIG, instead of the CONFIG=entry in Channel parameter, to locate <msgTypeCfg> entry in Value table. Refer to TCH Wrapper Mapper for more information.

For example, the default Request To CSM channel is configured with a CONFIG=IP_MAP_CFG_REQ_TO_CSM parameter. When an ISF message is received, the mapper looks for the <msgTypeCfg> entry in the Value table with the following conditions:
  • In Value table, the value of Category is
    • Environment.PMP.Variables.Rules.*[1].MAP_CONFIG if present.
    • IP_MAP_CFG_REQ_TO_CSM otherwise.
  • In msgTypeCfg entry, the value of subType is the same as the ISF Business Concept.
Note: If the ISF Business Concept ends in '_RPT', the mapper removes '_RPT' from the ISF Business Concept when looking for the <msgTypeCfg> entry.
Note: When the outbound mapper is used in conjunction with the Wrapper mapper, or the Business Application Header mapper, the Wrapper mapper or the Business Application Header mapper uses the entry with Category IP_CONFIG and Key IP_SCHEME_VER in Value table to identify the version of the TCH Real-Time Payment(RTP) system that Financial Transaction Manager for Immediate Payments supports, and stores the channel parameter config value in Environment.PMP.Variables.Rules.*[1].MAP_CONFIG which is used by the camt.056 outbound mapper. Refer to TCH Wrapper Mapper for more information.
The default <msgTypeCfg> for IP_MAP_CFG_REQ_TO_CSM is as follows.
<msgTypeCfg>
	<class>CAMT056</class>
	<subType>IP_TO_CSM_RCL</subType>
	<extendedCfg>
		<name>MASTER_FLAG</name>
		<value>N</value>
	</extendedCfg>
	<pt>
		<class>CAMT056</class>
		<subType>IP_TO_CSM_RCL</subType>
	</pt>
	<mapName>ISFToCamt056Mapper</mapName>
	<type>camt.056.001.05</type>
</msgTypeCfg>
The outbound mapper uses the configuration parameter of the <msgTypeCfg> entry as follows:
  • <type> - value for the namespace of the output camt.056 message. For TCH, the value must be camt.056.001.05 or camt.056.001.08.
Note: Since the ISFToCamt056Mapper is a common mapper which supports both camt.056.001.05/camt.056.001.08 for TCH and camt.056.001.01 for SCT Inst, the <type> value is used to specify the version of camt.056 that the mapper is supporting.

If the <msgTypeCfg> entry cannot be located, the mapper throws an exception with error 'subType not found'.

Table 2 shows the default configuration parameters for the channels using camt.056 outbound mapper.
Table 2. Default configuration parameters for channels using camt.056 outbound mapper
Category Class SubType Type
IP_MAP_CFG_REQ_TO_CSM CAMT056 IP_TO_CSM_RCL camt.056.001.05
IP_MAP_CFG_REQ_TO_CSM_29 CAMT056 IP_TO_CSM_RCL camt.056.001.08
IP_MAP_CFG_REQ_TO_CSM CAMT056 IP_TO_CSM_RCL_RPT camt.056.001.05
IP_MAP_CFG_REQ_TO_CSM_29 CAMT056 IP_TO_CSM_RCL_RPT camt.056.001.08
IP_MAP_CFG_REQ_TO_CSM_29 CAMT056 IP_TO_CSM_RFP_CANCEL camt.056.001.08
IP_MAP_CFG_REQ_TO_CSM_29 CAMT056 IP_TO_CSM_RFP_CANCEL_RPT camt.056.001.08
The outbound mapper handles the Datetime elements with the rules as follows.
  • If the Timezone is configured in the Channel table, the input datetime is mapped from the value with UTC timezone to the value in the format of the channel Timezone.
  • If the Timezone is not configured in the Channel table, the input datetime is mapped from the value with UTC timezone to the value in the format of the local timezone in which the mapper is executing.
The outbound mapper uses the channel parameter TS_INCLUDE_OFFSET to control whether the timezone offset is included in the output datetime values.
  • If TS_INCLUDE_OFFSET is set to Y, then the timezone offset is included in the output datetime values.
  • If TS_INCLUDE_OFFSET is set to N or not configured, then the timezone offset is not included in the output datetime values.