Response body
The following table shows the response body elements that are relevant for the current use case for the SEPA payment scheme. For details on all the response body elements for all supported payment schemes, see the Message field definition for pacs.004 .
Table: Retrieve payment return details – Relevant response body elements
Element | Description | Data type |
|---|---|---|
txInf.rtrlId | Unique payment return ID for the end customer | String |
txInf.rtrdIntrBkSttlmAmt | Data structure containing the payment currency and the amount to be returned. The currency is GBP, and the amount is a positive value that is equal to or less than the original payment amount. | Object |
Extract the values of the txInf.rtrlId, txInf.rtrdIntrBkSttlmAmt.value, and txInf.rtrdIntrBkSttlmAmt.ccy keys to see the payment return ID, amount, and currency.
Example response body for the SEPA payment scheme:
{
"pmtRtr": {
"grpHdr": {
"msgId": "msgId-6937484558",
"creDtTm": "2024-08-01T08:00:00.000+02:00",
"nbOfTxs": "1",
"sttlmInf": {
"sttlmMtd": "CLRG"
}
},
"txInf": [
{
"rtrId": "rtrId-6937484558",
"rtrdIntrBkSttlmAmt": {
"value": 10.04,
"ccy": "GBP"
},
"intrBkSttlmDt": "2024-08-01",
"chrgBr": "SLEV",
"instgAgt": {
"finInstnId": {
"bicfi": "ABBYGB20XXX"
}
},
"instdAgt": {
"finInstnId": {
"bicfi": "BSCHESM0XXX"
}
},
"rtrRsnInf": [
{
"rsn": {
"cd": "AC01"
},
"addtlInf": [
"raw-code",
"raw-description"
]
}
],
"orgnlTxRef": {
"pmtTpInf": {
"svcLvl": [
{
"prtry": "SEPA"
}
],
"lclInstrm": {
"prtry": "RTP"
}
},
"rmtInf": {
"strd": [
{
"cdtrRefInf": {
"ref": "validRef123"
}
}
]
},
"dbtr": {
"pty": {
"nm": "Debtor",
"pstlAdr": {
"adrTp": {
"cd": "ADDR"
},
"dept": "CL",
"strtNm": "NAME",
"bldgNm": "1",
"flr": "1",
"room": "D",
"pstCd": "EC1A 1AL",
"twnNm": "LONDON",
"twnLctnNm": "LONDON",
"ctrySubDvsn": "LONDON",
"ctry": "UK",
"adrLine": [
"CL. NAME, 1 1 D",
"EC1A 1AL LONDON LONDON"
]
},
"id": {
"prvtId": {
"othr": [
{
"id": "debitor-id"
}
]
}
}
}
},
"dbtrAcct": {
"id": {
"othr": {
"id": "12345678"
}
}
},
"dbtrAgt": {
"finInstnId": {
"bicfi": "ABBYGB20",
"clrSysMmbId": {
"mmbId": "777241"
}
}
},
"cdtrAgt": {
"finInstnId": {
"bicfi": "BSCHGBM0XXX",
"adrTp": {
"cd": "ADDR"
},
"dept": "CL",
"strtNm": "NAME",
"bldgNm": "1",
"flr": "2",
"room": "I",
"pstCd": "EC1A 1AL",
"twnNm": "LONDON",
"twnLctnNm": "LONDON",
"ctrySubDvsn": "LONDON",
"ctry": "UK",
"adrLine": [
"CL. NAME, 1 2 I",
"EC1A 1AL LONDON LONDON"
]
}
}
},
"cdtrAcct": {
"id": {
"iban": "GB91BARC20032634945865"
},
"ccy": "GBP"
}
}
}
]
}
}