Request For Return Inbound

The ReturnRequest method enables to process the Payment Return Request (RFR_IN) received from the sender.

Method: InboundServiceClient:ReturnRequest

Headers

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

Example

Payload Parameters

Parameter	Description
creditorAccount Mandatory	Object
accountNumber Mandatory	String Account number of the sender Example – "6464656646"
memberId Mandatory	String Routing numer of the sender bank/financial institution Example – "101115315"
name Mandatory	String Name of the sender Example – "P.Ramesh"
debtorAccount Mandatory	Object
accountNumber Mandatory	String Account number of the receiver Example – "6998802274"
memberId Mandatory	String Routing numer of the receiver bank/financial institution Example – "123456789"
name Mandatory	String Name of the receiver Example – "P.Ramesh"
msgID Mandatory	String Unique message identifier to identify the pacs.008 message Example – "M20231030123456789T1BTST94840796689"
orgMessageInfo Mandatory	Object
createdDateTime Mandatory	String Date and time of the request was created Example – "2023-10-30T04:31:03"
endToEndID Mandatory	String ID that enables to trace the transaction at any time during the process Example – "CBW2266485862U5655399"
instructedId Mandatory	String Payment reference ID of the transaction Example – "20231030987654321T1BTTST95636096689"
msgId Mandatory	String Unique message identifier to identify the pacs.008 message Example – "M20231030987654321T1BTST95636096689"
msgNmId Mandatory	String Name identifier of the original message Example – "pacs.008.001.08"
settlementAmount Mandatory	Object
amount Mandatory	Number Amount to be returned Example – 54750
currency Mandatory	String Currency code in which the transaction happens Example – "USD"
processor Mandatory	String Payment channel through which the transaction happens Example – "TCH" or "FedNow"
reason Mandatory	Object
code Mandatory	String Reason code for return request Example – "AC03"
referenceNumber Mandatory	String Reference number of the transaction Example – "M20231030987654321T1BTST95636096689"
transactionStatus Mandatory	String Current status of the transaction Example – "ACTC"
uuid Mandatory	String Unique ID present in the message Example – "c376b463-e3c4-486a-ac79-8ae402197408"

Request Body (Applicable for both FedNow and TCH)

{
    "creditorAccount": {
        "accountNumber": "69944546464946",
        "memberId": "101115315",
        "name": "Ramesh P"
    },
    "debtorAccount": {
        "accountNumber": "6998802274",
        "memberId": "123456789",
        "name": "P.Ramesh"
    },
    "msgID": "M20231030123456789T1BTST94840796689",
    "orgMessageInfo": {
        "createdDateTime": "2023-10-30T04:31:03",
        "endToEndId": "CBW2266485862U5655399",
        "instructedId": "20231030987654321T1BTTST95636096689",
        "msgId": "M20231030987654321T1BTST95636096689",
        "msgNmId": "pacs.008.001.08",
        "settlementAmount": {
            "amount": 54750,
            "currency": "USD"
        }
    },
    "processor": "TCH",
    "reason": {
        "code": "AC03"
    },
    "referenceNumber": "M20231030987654321T1BTST95636096689",
    "transactionStatus": "ACTC",
    "uuid": "c376b463-e3c4-486a-ac79-8ae402197408"
}

Response

Response Parameters

Parameter	Description
referenceNumber	String Reference number of the transaction Example – "M20231030987654321T1BTST95636096689"
status	String Status of the request Example – "Accepted"

Response Body (Applicable for both FedNow and TCH)

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