Get Payment Return

The GetPaymentReturn method enables to receive Payment Return Status Request initiated by the sender for which the bank responds with various statuses

Method: InboundServiceClient:GetPaymentReturnStatus

Headers

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

Example

Payload Parameters

Parameter	Description
referenceNumber Mandatory	String Reference number of the transaction Example – "2024041001100287757qrjZQHA0GhP5G"
transactionType Mandatory	String Type of the transaction Example – "FED_CCT_RETURN_IN"
instructedAmount Mandatory	Object
amount Mandatory	Number Amount of transaction as instructed by the sender Example – 120
currency Mandatory	String Currency code in which the transaction happens Example – "USD"
originalSettledAmount Mandatory	Object
amount Mandatory	Number Amount of original transaction that was settled Example –120
currency Mandatory	String Currency code in which the original transaction happened Example – "USD"
creditorAccount Mandatory	Object
name Mandatory	String Name of the beneficiary Example – "P.Ramesh"
accountNumber Mandatory	String Account number of the beneficiary Example – "6998802274"
memberId Mandatory	String Routing numer of the beneficiary bank/financial institution Example – "011000015"
debtorAccount Mandatory	Object
name Mandatory	String Name of the sender Example – "Ramesh P"
accountNumber Mandatory	String Account number of the sender Example – "69944546464946"
memberId Mandatory	String Routing numer of the sender bank/financial institution Example – "011002877"
orginalSettlementDate Mandatory	Object
Reason Mandatory	Object
Code Mandatory	String Code of reason for returning the transaction Example – "AC03"
additionalInfo Mandatory	String Additional information associated with the reason Example – "Reason"
originalReferenceNumber Mandatory	String Reference number of original transaction Example – "fwedRef2335"
rawMessage Mandatory	String Raw response message related to the transaction encoded in Base64 Example – "Base64 encoded data for received xml message"
msgID Mandatory	String Unique message identifier to identify the pacs.008 message Example – "2024041001100287757qrjZQHA0GhP5G"
settlementDate Mandatory	String Date and time of the transaction was settled Example – "2024-04-10"
transactionID Mandatory	String Unique ID generated for the transaction in processor Example – "20240410011000015fQUDevcBXbabXAR"
endToEndId Mandatory	String ID that enables to trace the transaction at any time during the process Example – "fwedRef2335"
instructingID Mandatory	String Payment reference ID of the transaction Example – "20240410011000015fQUDevcBXbabXAR"
processor Mandatory	String Payment channel through which the transaction happens Example – "FEDNOW"
uuid Mandatory	String Unique ID present in the message Example – "fbae0a40-e605-40a5-85ef-b99ae92b06da"

Request Body (Applicable only for FedNow)

//Request for status ACTC
{
    "referenceNumber": "2024041001100287757qrjZQHA0GhP5G",
    "transactionType": "FED_CCT_RETURN_IN",
    "instructedAmount": {
        "amount": 120,
        "currency": "USD"
    },
    "originalSettledAmount": {
        "amount": 120,
        "currency": "USD"
    },
    "creditorAccount": {
        "name": "P.Ramesh",
        "accountNumber": "6998802274",
        "memberId": "011000015"
    },
    "debtorAccount": {
        "name": "Ramesh P",
        "accountNumber": "69944546464946",
        "memberId": "011002877"
    },
    "orginalSettlementDate": "2024-04-10",
    "reason": {
        "code": "AC03",
        "additionalInfo": "Reason"
    },
    "originalReferenceNumber": "fwedRef2335",
    "rawMessage": "Base64 encoded data for received xml message",
    "msgID": "2024041001100287757qrjZQHA0GhP5G",
    "settlementDate": "2024-04-10",
    "transactionID": "20240410011000015fQUDevcBXbabXAR",
    "endToEndID": "fwedRef2335",
    "instructingID": "20240410011000015fQUDevcBXbabXAR",
    "processor": "FEDNOW",
    "uuid": "fbae0a40-e605-40a5-85ef-b99ae92b06da"
}
//Request for status RJCT
{
    "creditorAccount": {
        "accountNumber": "276512548912",
        "memberId": "222444666",
        "name": "Azath"
    },
    "debtorAccount": {
        "accountNumber": "24312446465612",
        "memberId": "000000005",
        "name": "Adash"
    },
    "endToEndID": "fedRef2295",
    "instructedAmount": {
        "amount": 2000,
        "currency": "USD"
    },
    "instructingID": "20240401222444666lmtGKhl7scokpBp",
    "msgID": "20240401000000005X7TeK8SDuxmyxfz",
    "orginalSettlementDate": "2023-01-31T17:48:04+05:30",
    "originalReferenceNumber": "fedRef2295",
    "originalSettledAmount": {
        "amount": 2000,
        "currency": "USD"
    },
    "processor": "FEDNOW",
    "rawMessage": "Base64 encoded data for received xml message",
    "reason": {
        "additionalInfo": "Duplicate payment",
        "code": "DUPL"
    },
    "referenceNumber": "20240401000000005X7TeK8SDuxmyxfz",
    "settlementDate": "2023-07-31T17:48:04+05:30",
    "transactionID": "20240401222444666lmtGKhl7scokpBp",
    "transactionType": "FED_CCT_RETURN_IN",
    "uuid": "c300b68d-6abb-4dc2-8bd6-e7231bd9990a"
}
//Request for status ACWP
{
    "creditorAccount": {
        "accountNumber": "276512548912",
        "memberId": "222444666",
        "name": "Azath"
    },
    "debtorAccount": {
        "accountNumber": "24312446465612",
        "memberId": "000000005",
        "name": "Adash"
    },
    "endToEndID": "fedRef2298",
    "instructedAmount": {
        "amount": 6000,
        "currency": "USD"
    },
    "instructingID": "20240401222444666wDsEdVle1JBwgJ2",
    "msgID": "202404010000000056WCbptW0HXNghAP",
    "orginalSettlementDate": "2023-01-31T17:48:04+05:30",
    "originalReferenceNumber": "fedRef2298",
    "originalSettledAmount": {
        "amount": 1000000,
        "currency": "USD"
    },
    "processor": "FEDNOW",
    "rawMessage": "Base64 encoded data for received xml message",
    "reason": {
        "additionalInfo": "Duplicate payment",
        "code": "DUPL"
    },
    "referenceNumber": "202404010000000056WCbptW0HXNghAP",
    "settlementDate": "2023-07-31T17:48:04+05:30",
    "transactionID": "20240401222444666wDsEdVle1JBwgJ2",
    "transactionType": "FED_CCT_RETURN_IN",
    "uuid": "64191f8f-9c22-4e7d-8a66-94113b15ffab"
}

Response

Response Parameters

Parameter	Description
reason	String Reason code for rejection – the ‘Reason code' is given, only if the status is ‘ RJCT' ( Rejected) Example – "BE10"
referenceNumber	String Reference number of the transaction Example – "20240401000000005X7TeK8SDuxmyxfz"
status	String Status of the transaction Example – "RJCT"
transactionType	String Type of the transaction Example – "FED_CCT_RETURN_IN"

Response Body (Applicable only for FedNow)

//Response for status ACTC
{
    "referenceNumber": "2024041001100287757qrjZQHA0GhP5G",
    "transactionType": "FED_CCT_RETURN_IN",
    "status": "ACTC"
}
//Response for status RJCT
{
    "reason": "BE10",
    "referenceNumber": "20240401000000005X7TeK8SDuxmyxfz",
    "status": "RJCT",
    "transactionType": "FED_CCT_RETURN_IN"
}
//Response for status ACWP
{
    "referenceNumber": "202404010000000056WCbptW0HXNghAP",
    "status": "ACWP",
    "transactionType": "FED_CCT_RETURN_IN"
}