Cancellation request via CHAPS (camt.056 v8)
This tutorial describes how you can make a CHAPS payment with the Payments Hub API and accompanies the header information found in the Payment Cancellation Request tutorial
The payment status is a message that notifies the status of the payment transaction, such as rejections or modifications to previously sent operations. The bank is notified that the operation could not be processed successfully or that the operation has been rejected, and the reason is detailed.
The status must include a JSON payload in the body of the request. The JSON payload is an ISO camt.056 v8 message with the root element TxInf and contains the details of the transaction rejection.
In this scenario, the issuing bank generates the camt.056 message and will receive notification that the payment has been rejected; the beneficiary bank also receives notification of the transaction status, although in the latter case this is for information purposes only.
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
Table: status of payment with CHAPS – Required request headers.
Message field | Description | Data type | Required/ Optional |
|---|---|---|---|
assgnmt.Id | Point to point reference, as assigned by the instructing party, and sent to the next party in the chain to unambiguously identify the message. Usage: The instructing party has to make sure that MessageIdentification is unique per instructed party for a pre-agreed period. | String | Optional |
assgnmt.CreDtTm | Date and time at which the message was created. | Date | Optional |
assgne.finInstnId | Name or identification (BIC) of the entity initiating the message | String | Required |
txInf.cxlId | Unique identifier, the value of the UID assigned by the default UI. | String | Required |
txInf.value | Amount of the transaction that was reported | Numeric | Required |
cxlRsnInf.rsn | Specific code explaining the reason for rejection or why the transaction was not processed | String | Required |
TxInf.dbtr | Agent who initiated the payment | String | Required |
TxInf.cdtrAgt | Agent of the payment recipient | String | Required |
Example request body:
{
"hubMessage": {
"messageType": "camt_056_v08",
"document": {
"fitoFIPmtCxlReq": {
"assgnmt": {
"assgnr": {
"agt": {
"finInstnId": {
"lei": "5493006QMFDDMYWIAM13",
"bicfi": "BSCHGB2LXXX"
}
}
},
"id": "CN251119DB87FE41",
"assgne": {
"agt": {
"finInstnId": {
"bicfi": "LOYDGB2LXXX"
}
}
},
"creDtTm": "2025-11-19T18:19:21.836Z"
},
"undrlyg": [
{
"txInf": [
{
"orgnlIntrBkSttlmAmt": {
"ccy": "GBP",
"value": 221200.5
},
"cxlRsnInf": [
{
"orgtr": {
"id": {
"orgId": {
"anyBIC": "BSCHGB2LXXX"
}
},
"nm": "SLIMBRIDGE ENERGY LIMITED"
},
"rsn": {
"cd": "CUST"
}
}
],
"orgnlUETR": "3f1c6e8b-ebe4-4dea-babb-7b6b568d7c3f",
"orgnlTxId": "e044b93e8e653f7abb1401bc838768ae",
"orgnlIntrBkSttlmDt": "2025-11-19",
"orgnlGrpInf": {
"orgnlMsgNmId": "pacs.008.001.08",
"orgnlCreDtTm": "2025-11-19T12:36:29.991Z",
"orgnlMsgId": "26bc8aa7748f39f1b259aa062d586cec"
},
"orgnlTxRef": {
"dbtrAcct": {
"id": {
"iban": "GB41BSCH09600162505250"
}
},
"cdtr": {
"pty": {
"nm": "GIP",
"pstlAdr": {
"twnNm": "NOT PROVIDED",
"ctry": "PT"
}
}
},
"dbtr": {
"pty": {
"nm": "SLIMBRIDGE ENERGY LIMITED",
"pstlAdr": {
"adrLine": [
"NOT PROVIDED",
"NOT PROVIDED"
]
}
}
},
"dbtrAgt": {
"finInstnId": {
"bicfi": "BSCHGB2LXXX"
}
},
"cdtrAcct": {
"id": {
"iban": "PT50001099996204896060223"
}
},
"cdtrAgt": {
"finInstnId": {
"bicfi": "BBPIPTPLXXX"
}
},
"sttlmInf": {
"clrSys": {
"cd": "STG"
},
"sttlmMtd": "CLRG"
},
"pmtTpInf": {
"svcLvl": [
{
"cd": "URGP"
}
]
}
},
"cxlId": "CN251119DB87FE41",
"orgnlInstrId": "00007M6VL8",
"case": {
"id": "CN251119DB87FE41",
"cretr": {
"agt": {
"finInstnId": {
"bicfi": "BSCHGB2LXXX"
}
}
}
},
"orgnlEndToEndId": "ReimbursementSHL"
}
]
}
],
"case": {
"id": "CN251119DB87FE41",
"cretr": {
"agt": {
"finInstnId": {
"bicfi": "BSCHGB2LXXX"
}
}
}
}
}
},
"client": {
"internalId": "3781",
"initiator": "scib-converter"
},
"flow": "emission"
},
"executionId": {
"paymentHubId": "ea103d12-912d-369f-8771-50fdd2f02c42",
"executionNumber": 0
}
}