Cancellation request (camt.056)

Prev Next

Cancelling payments with SEPA Instant Credit Transfer (camt.056)

This tutorial describes how you can request a cancellation of a previously sent SEPA Instant Credit Transfer (SCT Inst) using the PagoNxt Payments Hub API and accompanies the header information found in the Cancellation request message tutorial

For this tutorial, consider a scenario where a customer has sent a SEPA Instant payment, but realizes that it was incorrect, and wants to cancel it.

Sandbox

These instructions apply to the Sandbox environment

Payment Cancellation Request

Request body

The request must include a JSON payload object in the request body. The JSON payload is a camt.056 ISO message with the fitoFIPmtCxlReq root element, and it contains the request details for cancelling a payment.

The following table only provides information about some especially important fields. For details on all the required and optional message fields, see Message field definition for camt.056 .


Message field

Description

Data type

Required/Optional

assgnmt.id

Assignment ID that uniquely identifies the investigation assignment.

This ID is used internally for idempotency of the API.

String

Required

assgnmt.assgnr

Data structure containing the assigner details.

For this scenario, this is the customer’s agent.

Object

Required

assgnmt.assgne

Data structure containing the assignee details.

For this scenario, this is the merchant’s agent.

Object

Required

assgnmt.creDtTm

Assignment Creation date and time

ISODateTime

Required

ctrlData.nbOfTxs

The number of transactions included in this assignment.

Must be equal to 1.

string

Required

undrlyg.txInf.cxlId

ID that uniquely identifies the cancellation request, as assigned by the assigner.

String

Required

undrlyg.txInf.orgnlTxRef.intrBkSttlAmt

Data structure containing the payment currency and the amount of the original transaction.

The currency must be EUR and the amount must be a positive value.

Object

Required

undrlyg.txInf.cxlRsnInf

Array of information about the cancellation reason

Array

Required

undrlyg.txInf.orgnlTxId

Original transaction ID, from the pacs.008 txId field.

String

Required

undrlyg.txInf.orgnlIntrBkSttlmDt

Original interbank settlement amount, from the pacs.008 intrBkSttlmAmt field.

String

Reauired

undrlyg.txInf.orgnlGrpInf

Data structure containing:

*Message ID used in the original payment request

*Name of the message format used in the original request.

Object

Required

undrlyg.txInf.orgnlTxRef

Data structure containing the transaction reference used to identify the original transaction

Object

Required

Example body request:

{
  "fitoFIPmtCxlReq": {
    "assgnmt": {
      "assgnr": {
        "agt": {
          "finInstnId": {
            "bicfi": "IPAYESMMXXX"
          }
        }
      },
      "id": "20f1839852c53efc89b4661752149425",
      "assgne": {
        "agt": {
          "finInstnId": {
            "bicfi": "BSCHDEFFXXX"
          }
        }
      },
      "creDtTm": "2025-07-10T12:10:24.953Z"
    },
    "ctrlData": {
      "nbOfTxs": "1"
    },
    "undrlyg": [
      {
        "txInf": [
          {
            "orgnlIntrBkSttlmAmt": {
              "ccy": "EUR",
              "value": 2.42
            },
            "cxlRsnInf": [
              {
                "orgtr": {
                  "id": {
                    "orgId": {
                      "anyBIC": "BSCHESMMXXX"
                    }
                  }
                },
                "rsn": {
                  "cd": "DUPL"
                }
              }
            ],
            "orgnlTxId": "00490001632XQJZNFB",
            "orgnlIntrBkSttlmDt": "2024-09-13",
            "orgnlGrpInf": {
              "orgnlMsgNmId": "pacs.008.001.08",
              "orgnlMsgId": "1981259ee94c3cc9854350a1b914e758"
            },
            "orgnlTxRef": {
              "dbtrAcct": {
                "id": {
                  "iban": "ES5500490001532111373722"
                }
              },
              "cdtr": {
                "pty": {
                  "nm": "DOC07815006C DOC07815006C ES"
                }
              },
              "dbtr": {
                "pty": {
                  "nm": "Q.G. ARREDAMENTI S.A.S."
                }
              },
              "dbtrAgt": {
                "finInstnId": {
                  "bicfi": "BSCHESMMXXX"
                }
              },
              "cdtrAcct": {
                "id": {
                  "iban": "DE25503205000450340253"
                }
              },
              "cdtrAgt": {
                "finInstnId": {
                  "bicfi": "BSCHDEFFXXX"
                }
              },
              "sttlmInf": {
                "clrSys": {
                  "prtry": "TIP"
                },
                "sttlmMtd": "CLRG"
              },
              "pmtTpInf": {
                "svcLvl": [
                  {
                    "cd": "SEPA"
                  }
                ],
                "lclInstrm": {
                  "cd": "INST"
                }
              }
            },
            "cxlId": "cxlid2409161752149425",
            "orgnlEndToEndId": "NOT PROVIDED"
          }
        ]
      }
    ]
  }
}