Return Request Response

The ReturnRequestResponse method enables to receive response for the Payment Return Request (RFR_OUT) initiated by the sender

Method: InboundServiceClient:ReturnRequestResponse

Headers

Name	Value
Credential	"Basic c3VwcG9ydCsxQG5ldHN5cy1pbmMuY29tOjM5ZDYxOGJkNTVmN5NWQxY2RlNDE5"
Signature	"{{signature}}"

Example

Payload Parameters

Parameter	Description
caseID Mandatory	String Unique case ID of the request for payment return Example – "CASE91000035"
creditorAccount Mandatory	Object
accountNumber Mandatory	String Account number of the beneficiary Example – "69944546464946"
memberId Mandatory	String Routing numer of the beneficiary bank/financial institution Example – "011000015"
name Mandatory	String Name of the beneficiary Example – "Ramesh P"
debtorAccount Mandatory	Object
accountNumber Mandatory	String Account number of the sender Example – "6998802274"
memberId Mandatory	String Routing numer of the sender bank/financial institution Example – "222444666"
name Mandatory	String Name of the sender Example – "P.Ramesh"
msgID Mandatory	String Unique message identifier to identify the pacs.008 message Example – "20240401123456789sCe9KAKQ0LqoMTD"
orgMessageInfo Mandatory	Object
endToEndId Mandatory (applicable only for FedNow)	String ID that enables to trace the original message at any time during the process Example – "fedRef2301"
instructedId Mandatory (applicable only for FedNow)	String Unique ID of the original instructed message Example – "20240401222444666VACLUF1oAniXgMB"
msgId Mandatory	String Unique message identifier to identify the original message Example – "20240401111222baNjLJKqqqdDhDk"
msgNmId Mandatory	String Unique ID of the message name that indicates the type of message Example – "pacs.008.001.08"
transactionId Mandatory	String Unique ID generated for the original transaction Example – "20240531101110802iJFF3rIADibzPXC"
processor Mandatory	String Payment channel through which the transaction happens Example – "FEDNOW"
referenceNumber Mandatory	String Reference number of the Return Request response message Example – "20240603101110802a7GGSvzGuSJNHZG"
resultedInfo Mandatory	Object
settlementAmount Mandatory (applicable only for FedNow)	Object
amount Mandatory (applicable only for FedNow)	Number Amount to be returned Example – 1000000
currency Mandatory (applicable only for FedNow)	String Currency code in which the transaction happens Example – "USD"
settlementDate Optional	String Date and time of the transaction was completed Example – "2024-04-01"
transactionId Optional	String Unique ID of the original transaction Example – "20240401222444666VACLUF1oAniXgMB"
status Mandatory	String Response status for the request Possible Values: IPAY PECR PDCR RJCR Example – "IPAY"
transactionStatus Mandatory	String Current status of the transaction Example – "ACSC"
uuid Mandatory	String Unique ID present in the message Example – "61d31a62-12f1-4a16-bd45-cdb7ba4d50a9"

Request Body (Applicable for both FedNow & TCH)

//Return request accepted (IPAY) 
{
    "caseID": "CASE91000035",
    "creditorAccount": {
        "accountNumber": "69944546464946",
        "memberId": "111113333",
        "name": "Ramesh P"
    },
    "debtorAccount": {
        "accountNumber": "6998802274",
        "memberId": "222444666",
        "name": "P.Ramesh"
    },
    "msgID": "20240401123456789sCe9KAKQ0LqoMTD",
    "orgMessageInfo": {
        "endToEndId": "fedRef2301", //applicable only for FedNow
        "instructedId": "20240401222444666VACLUF1oAniXgMB", //applicable only for FedNow
        "msgId": "20240401111222baNjLJKqqqdDhDk",
        "msgNmId": "pacs.008.001.08",
        "transactionId": "20240531101110802iJFF3rIADibzPXC"
    },
    "processor": "FEDNOW",
    "referenceNumber": "fedRef2301",
    "resultedInfo": {
        "settlementAmount": {
            "amount": 1000000,
            "currency": "USD"
        },
        "settlementDate": "2024-04-01", //applicable only for FedNow
        "transactionId": "20240401222444666VACLUF1oAniXgMB" //applicable only for FedNow
    },
    "status": "IPAY",
    "transactionStatus": "ACSC",
    "uuid": "61d31a62-12f1-4a16-bd45-cdb7ba4d50a9"
}
//Partially executed return request (PECR)
{
    "caseID": "CASE91000037",
    "creditorAccount": {
        "accountNumber": "69944546464946",
        "memberId": "111113333",
        "name": "Ramesh P"
    },
    "debtorAccount": {
        "accountNumber": "6998802274",
        "memberId": "222444666",
        "name": "P.Ramesh"
    },
    "justficationData": { //applicable only for FedNow
        "additionalInfo": "Test Information",
        "code": "IN15"
    },
    "msgID": "202404011234567893QvcQbbRLrmkra7",
    "orgMessageInfo": {
        "endToEndId": "fedRef2303", //applicable only for FedNow
        "instructedId": "20240401222444666CerVc1DDF5i5QwF", //applicable only for FedNow
        "msgId": "202404011112222r5YtEMa1p4XHYd",
        "msgNmId": "pacs.008.001.08"
    },
    "processor": "FEDNOW",
    "referenceNumber": "fedRef2303",
    "resultedInfo": {
        "endToEndId": "fedRef2303", //applicable only for FedNow
        "settlementAmount": {
            "amount": 70000,
            "currency": "USD"
        },
        "settlementDate": "2024-04-01", //applicable only for FedNow
        "transactionId": "20240401222444666CerVc1DDF5i5QwF" //applicable only for FedNow
    },
    "status": "PECR",
    "transactionStatus": "ACSC",
    "uuid": "4ebd3671-bb5c-4c5b-b053-ffbb80f5ecfe"
}
//Return request pending investigation (PDCR) (PDCR status is applicable only for FedNow)
{
    "caseID": "CASE91000038",
    "creditorAccount": {
        "accountNumber": "69944546464946",
        "memberId": "111113333",
        "name": "Ramesh P"
    },
    "debtorAccount": {
        "accountNumber": "6998802274",
        "memberId": "222444666",
        "name": "P.Ramesh"
    },
    "justficationData": {
        "additionalInfo": "Test Information",
        "code": "IN15"
    },
    "msgID": "20240401123456789p0mld6jYcrwMNQm",
    "processor": "FEDNOW",
    "referenceNumber": "fedRef2304",
    "status": "PDCR",
    "transactionStatus": "ACSC",
    "uuid": "63c1c3fe-25ac-48b3-bb4e-12e66c312ddf"
}
//Return request rejected (RJCR)
{
    "caseID": "CASE91000036",
    "creditorAccount": {
        "accountNumber": "69944546464946",
        "memberId": "111113333",
        "name": "Ramesh P"
    },
    "debtorAccount": {
        "accountNumber": "6998802274",
        "memberId": "222444666",
        "name": "P.Ramesh"
    },
    "justficationData": { //applicable only for FedNow
        "additionalInfo": "Test Information",
        "code": "E981"
    },
    "msgID": "202404011234567897104es0XEsmyJkk",
    "orgMessageInfo": {
        "endToEndId": "fedRef2302", //applicable only for FedNow
        "instructedId": "20240401222444666ClruFLPC5yg2Cn4", //applicable only for FedNow
        "msgId": "20240401111222teWhG5Yw112mLxm",
        "msgNmId": "pacs.008.001.08"
    },
    "processor": "FEDNOW",
    "referenceNumber": "fedRef2302",
    "resultedInfo": { //applicable only for TCH
        "settlementAmount": {
            "amount": 40000,
            "currency": "USD"
        }
    },
    "status": "RJCR",
    "transactionStatus": "ACSC",
    "uuid": "8f63aab0-063f-4ac1-ae38-a6f780c02c7b"
}

Response

Response Parameters

Parameter	Description
referenceNumber	String Reference number of the response for payment return request Example – "cbw12213436"
status	String Status of the response Example – "Accepted"

Response Body (Applicable for both FedNow & TCH)

{
  "referenceNumber": "cbw12213436",
  "status": "Accepted"
}