Payment Return

The PaymentReturn API enables to return the received payment to the originator.

Method: POST

{{URL}}/rtp/rpc/TransactionService/PaymentReturn

Headers

Name	Value
Content-Type	application/json
Credential	"Basic c3VwcG9ydCsxQG5ldHN5cy1pbmMuY29tOjM5ZDYxOGJkNTVmN5NWQxY2RlNDE5"
Signature	"{{signature}}"

Example

Payload Parameters

Parameter	Description
processor Mandatory	String Payment channel through which the transaction happens Example – "FEDNOW" or "TCH"
referenceNumber Mandatory	String Reference number of inbound transaction Example – "CBWREF202305250093"
OriginalMessageId Mandatory	String Message ID of original inbound transaction Example – "20230725101115302OJxpnyeKCYEVvut"
debtorAccount Mandatory	Object
name Mandatory	String Account name of the initiator of transaction Example – "P Ramesh"
accountNumber Mandatory	String Account number of the initiator of transaction Example – "987654321"
memberId Mandatory	String Bank routing number of the initiator of transaction Example – "101115302"
creditorAccount Mandatory	Object
name Mandatory	String Account name of the receiver of transaction Example – "Poongavanam"
accountNumber Mandatory	String Account number of the receiver of transaction Example – "123456789"
memberId Mandatory	String Bank Routing number of the receiver of transaction Example – "92413659999"
returnedSettledAmount Mandatory	Object
amount Mandatory	Number Amount that is returned for original transaction Example – 100
currency Mandatory	String Currency code of returning amount Example – "USD"
reason Mandatory	Object
code Mandatory	String Reason code for returning the amount Example – "DUPL"
additionalInfo Mandatory	String Additional information on returning the amount Example – "Duplicate Payment returning"

cURL

curl --location '{{URL}}/rtp/rpc/TransactionService/PaymentReturn' \
--header 'Content-Type: application/json' \
--data '{"processor":"FEDNOW","referenceNumber":"CBWREF202305250093","OriginalMessageId":"20230725101115302OJxpnyeKCYEVvut","debtorAccount":{"name":"P Ramesh","accountNumber":"987654321","memberId":"101115302"},"creditorAccount":{"name":"Poongavanam","accountNumber":"123456789","memberId":"92413659999"},"returnedSettledAmount":{"amount":100,"currency":"USD"},"reason":{"code":"DUPL","additionalInfo":"Duplicate Payment returning"}}'

C#

var options = new RestClientOptions("{{URL}}")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("/rtp/rpc/TransactionService/PaymentReturn", Method.Post);
request.AddHeader("Content-Type", "application/json");
var body = @"{
" + "\n" +
@"    ""processor"": ""FEDNOW"",
" + "\n" +
@"    ""referenceNumber"": ""CBWREF202305250093"",
" + "\n" +
@"    ""OriginalMessageId"": ""20230725101115302OJxpnyeKCYEVvut"",
" + "\n" +
@"    ""debtorAccount"": {
" + "\n" +
@"        ""name"": ""P Ramesh"",
" + "\n" +
@"        ""accountNumber"": ""987654321"",
" + "\n" +
@"        ""memberId"": ""101115302""
" + "\n" +
@"    },
" + "\n" +
@"    ""creditorAccount"": {
" + "\n" +
@"        ""name"": ""Poongavanam"",
" + "\n" +
@"        ""accountNumber"": ""123456789"",
" + "\n" +
@"        ""memberId"": ""92413659999""
" + "\n" +
@"    },
" + "\n" +
@"    ""returnedSettledAmount"": {
" + "\n" +
@"        ""amount"": 100,
" + "\n" +
@"        ""currency"": ""USD""
" + "\n" +
@"    },
" + "\n" +
@"    ""reason"": {
" + "\n" +
@"        ""code"": ""DUPL"",
" + "\n" +
@"        ""additionalInfo"": ""Duplicate Payment returning""
" + "\n" +
@"    }
" + "\n" +
@"}";
request.AddStringBody(body, DataFormat.Json);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);

Go

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "{{URL}}/rtp/rpc/TransactionService/PaymentReturn"
  method := "POST"

  payload := strings.NewReader(`{`+"
"+`
    "processor": "FEDNOW",`+"
"+`
    "referenceNumber": "CBWREF202305250093",`+"
"+`
    "OriginalMessageId": "20230725101115302OJxpnyeKCYEVvut",`+"
"+`
    "debtorAccount": {`+"
"+`
        "name": "P Ramesh",`+"
"+`
        "accountNumber": "987654321",`+"
"+`
        "memberId": "101115302"`+"
"+`
    },`+"
"+`
    "creditorAccount": {`+"
"+`
        "name": "Poongavanam",`+"
"+`
        "accountNumber": "123456789",`+"
"+`
        "memberId": "92413659999"`+"
"+`
    },`+"
"+`
    "returnedSettledAmount": {`+"
"+`
        "amount": 100,`+"
"+`
        "currency": "USD"`+"
"+`
    },`+"
"+`
    "reason": {`+"
"+`
        "code": "DUPL",`+"
"+`
        "additionalInfo": "Duplicate Payment returning"`+"
"+`
    }`+"
"+`
}`)

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/json")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

NodeJs

var https = require('follow-redirects').https;
var fs = require('fs');

var options = {
  'method': 'POST',
  'hostname': '{{URL}}',
  'path': '/rtp/rpc/TransactionService/PaymentReturn',
  'headers': {
    'Content-Type': 'application/json'
  },
  'maxRedirects': 20
};

var req = https.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function (chunk) {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });

  res.on("error", function (error) {
    console.error(error);
  });
});

var postData = JSON.stringify({
  "processor": "FEDNOW",
  "referenceNumber": "CBWREF202305250093",
  "OriginalMessageId": "20230725101115302OJxpnyeKCYEVvut",
  "debtorAccount": {
    "name": "P Ramesh",
    "accountNumber": "987654321",
    "memberId": "101115302"
  },
  "creditorAccount": {
    "name": "Poongavanam",
    "accountNumber": "123456789",
    "memberId": "92413659999"
  },
  "returnedSettledAmount": {
    "amount": 100,
    "currency": "USD"
  },
  "reason": {
    "code": "DUPL",
    "additionalInfo": "Duplicate Payment returning"
  }
});

req.write(postData);

req.end();

Request Body (Applicable for both FedNow and TCH)

{
    "processor": "FEDNOW",
    "referenceNumber": "CBWREF202305250093",
    "OriginalMessageId": "20230725101115302OJxpnyeKCYEVvut",
    "debtorAccount": {
        "name": "P Ramesh",
        "accountNumber": "987654321",
        "memberId": "101115302"
    },
    "creditorAccount": {
        "name": "Poongavanam",
        "accountNumber": "123456789",
        "memberId": "92413659999"
    },
    "returnedSettledAmount": {
        "amount": 100,
        "currency": "USD"
    },
    "reason": { 
        "code": "DUPL",
        "additionalInfo": "Duplicate Payment returning"
    }
}

Response: 200

Response Parameters

Parameter	Description
reponse	String Response received for the given request Example – "JSON Representation of Received Response"
message	String Status message of the returning payment Example – "success"
transactionID	String Unique ID generated for the transaction Example – "20230818101110802ccoYjFWuaNnr7Ur"
instructingId	String Payment reference ID of the transaction Example – "VBeVx1zTkh23OSFfEh1irjTedNDMgf"
acceptedDate	String Date and time of the transaction was processed Example – "2024-03-28T19:32:20+05:30"
endToEndId	String ID that enables to trace the transaction at any time during the process Example – "20240328000000005UbY1yJNb8zDQBes"
messageId	String Unique message ID generated for the transaction Example – "20240328111222BpHpukCm6nfEx1H"
settlementDate	String Date and time of the transaction was completed Example – "2024-03-28"
rawMessage (Applicable only for FedNow)	String Raw response message related to the transaction encoded in Base64 Example – "Base64 Value of Received Response"
status	String Current status of the transaction Example – "ACSC"

Response Body (Applicable for both FedNow and TCH)

{
  "response": "JSON Representation of Received Response",
  "message": "success",
  "transactionID": "20230818101110802ccoYjFWuaNnr7Ur",
  "instructingId": "VBeVx1zTkh23OSFfEh1irjTedNDMgf",
  "acceptedDate": "2024-03-28T19:32:20+05:30",
  "endToEndId": "20240328000000005UbY1yJNb8zDQBes",
  "messageId": "20240328111222BpHpukCm6nfEx1H",
  "settlementDate": "2024-03-28",
  "rawMessage": "Base64 Value of Received Response",  //applicable only for FedNow
  "status": "ACSC"
}