camt.056.001.08 XSD schema and business logic

A camt.056 is a Financial Institution to Financial Institution Payment Cancellation Request, used to request the cancellation of a previously sent payment instruction. It operates in the cash management (camt) namespace and is the counterpart to the camt.029 resolution-of-investigation message.

1. Message definition and structure

Access the message definition and structure here.

Document
└── FIToFIPmtCxlReq          ← Root business message
    ├── Assgnmt   [1..1]      ← Case assignment (mandatory)
    ├── Case      [0..1]      ← Case identification (optional)
    ├── CtrlData  [0..1]      ← Control totals (optional)
    ├── Undrlyg   [1..n]      ← Underlying transaction(s) (at least one mandatory)
    └── SplmtryData [0..n]    ← Supplementary / proprietary data (optional)

2. Business logic

2.1. Case assignment (`Assgnmt`)

The case assignment tag identifies who is assigning the case to whom

Element	Name	Presence	Description
`Id`	Case identification	Mandatory	Unique assignment identifier (same as message id)
`Assgnr`	Case assigner	Mandatory	Party assigning the case (only Agent accepted)
`Assgne`	Case assignee	Mandatory	Party receiving the case (only Agent accepted)
`CreDtTm`	Creation date time	Mandatory	Creation date time

2.2. Case (`Case`)

The case tag is ignored on incoming camt.056 and will not be populated for outgoing camt.056.

2.3. Control data (`CtrlData`)

The optional control data tag contains the transaction count (NbOfTxs) and control sum (CtrlSum) for the whole cancellation message.

If present on incoming camt.056, its values will be checked against the list of underlying payments content.

For outgoing camt.056, only the transaction count will be updated.

2.4. Underlying payment (`Undrlyg`)

The underlying payment can be either the whole payment group (OrgnlGrpInfAndCxl) or a list of individual payments (TxInf). Mambu Payments only supports individual payments.

Each individual underlying payment is mapped according to the same rules as the incoming pacs.002 original payment identification here. The tags that will be taken into account to find the related payment are:

TxInf.OrgnlGrpInf.OrgnlMsgId
TxInf.OrgnlGrpInf.OrgnlMsgNmId
TxInf.OrgnlInstrId
TxInf.OrgnlEndToEndId
TxInf.OrgnlTxId
TxInf.OrgnlUETR

2.5. Identification of the cancellation id (`CxlId`)

Each cancellation request is identified by a unique ID located at TxInf.CxlId that must be max 35 text.

2.6. Cancellation reason (`CxlRsnInf`)

The cancellation reason is provided by the TxInf.CxlRsnInf tag with following information:

Element	Name	Presence	Description
`Orgtr`	Originator	Mandatory	Originator If Reason code is `CUST` (customer request), the `Orgtr.Nm` (originator name) must be valued Else for other reason codes, the `Orgtr.Id.OrgId` must be valued with the bank code of the financial institution: `Orgtr.Id.OrgId.AnyBIC` if the bank code is a BIC format `Orgtr.Id.OrgId.Othr.Id` if the bank code is another format than a BIC
`Rsn.Cd`	Reason code	Mandatory	Reason code. Examples: `DUPL` — Duplicate payment `FRAD` — Fraudulent origin `TECH` — Technical problem `CUST` — Customer request `AC03` — Invalid creditor account number `AM09` — Wrong amount `CXLR` — Cancellation requested by counterpart
`AddtlInf`	Additional information	Optional	Additional information

2.7. Original Transaction Reference (`OrgnlTxRef`)

This tag echoes of the key fields from the original payment to help the receiving bank identify it. It usually contains the amount, interbank settlement amount and date, as well as parties (debtor, creditor, ultimate parties) description.

Mambu Payments do not rely on this information to find the related payment.

1. Message definition and structure

2. Business logic

2.1. Case assignment (Assgnmt)

2.2. Case (Case)

2.3. Control data (CtrlData)

2.4. Underlying payment (Undrlyg)

2.5. Identification of the cancellation id (CxlId)

2.6. Cancellation reason (CxlRsnInf)

2.7. Original Transaction Reference (OrgnlTxRef)