Getting payments details (pacs.008)
This tutorial describes how you can get payment details with the Payments Hub API and accompanies the information in the general Get payment details tutorial here
For this tutorial, consider a scenario where a customer wants to see the ID of each transaction for a payment they have previously made. The Payments Hub API can be used to retrieve these details. The tutorial describes how you can retrieve the payment details using the ISO pacs.008 message.
Note
The instructions in this tutorial apply to the sandbox environment.
Response body
The following table shows the response body elements that are relevant for the current use case for the Faster Payments (FP) payment scheme. For details on all the response body elements for all supported payment schemes, see the Message field definition for pacs.008 .
Extract the value of the cdtTrfTxInf.pmtId.txId key to see the transaction IDs for the payment.
Table: Retrieve payment details – Relevant response body elements.
Element | Description | Data type |
|---|---|---|
grpHdr.msgId | Message ID, which uniquely identifies each request that was sent. This ID is used internally for idempotency of the API. | String |
grpHdr.creDtTm | Date and time of the payment submission request | String |
grpHdr.nbOfTxs | Number of transactions within the message. Value: 1 | String |
grpHdr.ttlIntrBkSttlmAmt | Data structure containing the payment currency and the amount for the total interbank settlement. The currency is GBP and the amount is a positive value. If these fields are used, the amount is equal to the sum of all the transactions in the message. | Object |
grpHdr.sttlmInf.sttlmMtd | Settlement method. Value: CLRG | String |
cdtTrfTxInf.pmtId.endToEndId | End-to-end ID, which can be used to track the transaction between payment systems. If the ID is not available, the value is NOT PROVIDED. | String |
cdtTrfTxInf.pmtId.txId | Transaction ID, which uniquely identifies each transaction within the message | String |
cdtTrfTxInf.pmtTpInf.svcLvl.prtry | Payment scheme type. Value: FP | String |
cdtTrfTxInf.pmtTpInf.lclInstrm.prtry | Faster Payments Scheme (FPS) processing code | String |
cdtTrfTxInf.pmtTpInf.ctgyPurp.prtry | Payment channel | String |
cdtTrfTxInf.intrBkSttlmAmt | Data structure containing the payment currency and the amount that was transferred. The currency is GBP and the amount is a positive value. | Object |
cdtTrfTxInf.chrgBr | Charge bearer type. The possible values are:
| String |
cdtTrfTxInf ► .intrmyAgt1 ► .intrmyAgt1Acct | Data structures containing the details for the intermediary agent and the agent's account. These structures are required if you use multiple agencies and agency accounts for debiting. | Object |
cdtTrfTxInf ► .dbtr ► .dbtrAcct ► .dbtrAgt | Data structures containing the details for the debtor, the debtor’s account, and the debtor agent | Object |
cdtTrfTxInf ► .cdtrAgt ► .cdtr ► .cdtrAcct | Data structures containing the details for the creditor agent, the creditor, and the creditor’s account | Object |
cdtTrfTxInf.rmtInf | Data structure containing remittance details | Object |
Example response body for the FP payment scheme:
{
"fitoFICstmrCdtTrf": {
"grpHdr": {
"msgId": "MsgId-44458394999944",
"creDtTm": "2022-02-03T11:08:19.664+01:00",
"nbOfTxs": "1",
"sttlmInf": {
"sttlmMtd": "CLRG"
}
},
"cdtTrfTxInf": [
{
"pmtId": {
"endToEndId": "e2eId-1587641040",
"txId": "111112"
},
"pmtTpInf": {
"svcLvl": [
{
"prtry": "FP"
}
],
"lclInstrm": {
"prtry": "SIP"
}
},
"intrBkSttlmAmt": {
"value": 10.04,
"ccy": "GBP"
},
"chrgBr": "SHAR",
"dbtr": {
"nm": "Steve",
"pstlAdr": {
"twnNm": "miltonKeynes",
"ctry": "GB",
"adrLine": [
"Somewhere in MK"
]
}
},
"dbtrAcct": {
"id": {
"othr": {
"id": "12345678"
}
}
},
"dbtrAgt": {
"finInstnId": {
"bicfi": "ABBYGB20",
"clrSysMmbId": {
"mmbId": "090401"
},
"pstlAdr": {
"twnNm": "miltonKeynes",
"ctry": "GB",
"adrLine": [
"Somewhere in MK"
]
}
}
},
"cdtrAgt": {
"finInstnId": {
"bicfi": "ABBYGB3E",
"clrSysMmbId": {
"mmbId": "090401"
},
"pstlAdr": {
"twnNm": "miltonKeynes",
"ctry": "GB",
"adrLine": [
"Somewhere in MK"
]
}
}
},
"cdtr": {
"nm": "Creditor",
"pstlAdr": {
"twnNm": "miltonKeynes",
"ctry": "GB",
"adrLine": [
"Somewhere in MK"
]
}
},
"cdtrAcct": {
"id": {
"iban": "GB91BARC09023134945865"
}
},
"rmtInf": {
"strd": [
{
"cdtrRefInf": {
"ref": "validref123"
}
}
]
}
}
]
}
}