Request For Payment Response

The RequestForPaymentResponse API enables to repond the respective payment request (RFP_IN) from the beneficiary.

Method: POST

{{URL}}/rtp/rpc/TransactionService/RequestForPaymentResponse

Headers

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

Example

Payload Parameters

Parameter	Description
FedNow
referenceNumber Mandatory	String Reference number of the inbound request for payment Example – "20240328011002725axj5LnqYiPkISNM"
status Mandatory	String Response status of the transaction Possible response statuses – PRES, ACTC, RJCT. Example – "PRES"
processor Mandatory	String Payment channel through which the transaction happens Example – "FEDNOW"
reason Mandatory	Object
code Mandatory	String Reason code of the rejection status Example – "AC02"
acceptedAmount Mandatory	Object
amount Mandatory	Number Amount accepted for the request Example – 1500
currency Mandatory	String Currency code of the accepted amount Example – "69988022968"
TCH
processor Mandatory	String Payment channel through which the transaction happens Example – "TCH"
referenceNumber Mandatory	String Reference number of the inbound request for payment Example – "M20240319111112222T1BTST62015255801"
status Mandatory	String Response status of the transaction Example – "RJCT"
reason Mandatory	Object
code Mandatory	String Reason code of the rejection status Example – "AC06"
additionalInfo Mandatory	String Additional information given with the reason Example – "Account Closed"

cURL

curl --location '{{URL}}/rtp/rpc/TransactionService/RequestForPaymentResponse' \
--header 'Content-Type: application/json' \
--data '{"processor":"TCH","referenceNumber":"M20240319111112222T1BTST62015255801 ","status":"RJCT","reason":{"code":"AC06","additionalInfo":"Something"}}'

C#

var options = new RestClientOptions("{{URL}}")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("/rtp/rpc/TransactionService/RequestForPaymentResponse", Method.Post);
request.AddHeader("Content-Type", "application/json");
var body = @"{
" + "\n" +
@"    ""processor"": ""TCH"",
" + "\n" +
@"    ""referenceNumber"": ""M20240319111112222T1BTST62015255801 "",
" + "\n" +
@"    ""status"": ""RJCT"",
" + "\n" +
@"    ""reason"": {
" + "\n" +
@"        ""code"": ""AC06"",
" + "\n" +
@"        ""additionalInfo"": ""Something""
" + "\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/RequestForPaymentResponse"
  method := "POST"

  payload := strings.NewReader(`{`+"
"+`
    "processor": "TCH",`+"
"+`
    "referenceNumber": "M20240319111112222T1BTST62015255801 ",`+"
"+`
    "status": "RJCT",`+"
"+`
    "reason": {`+"
"+`
        "code": "AC06",`+"
"+`
        "additionalInfo": "Something"`+"
"+`
    }`+"
"+`
}`)

  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/RequestForPaymentResponse',
  '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": "TCH",
  "referenceNumber": "M20240319111112222T1BTST62015255801 ",
  "status": "RJCT",
  "reason": {
    "code": "AC06",
    "additionalInfo": "Something"
  }
});

req.write(postData);

req.end();

Request Body for FedNow

//Status - Presented
{
    "referenceNumber": "20240328011002725axj5LnqYiPkISNM",
    "status": "PRES",
    "processor": "FEDNOW"
}
//Status - Accepted
{
    "referenceNumber": "20230823267084131Gqc04K4L6duVXrw",
    "status": "ACTC"
}
//Status - Rejected
{
    "referenceNumber": "20230806101110802lecugQb6Se4IdaJ",
    "status": "RJCT",
    "reason": {
        "code": "AC02"
    }
}
//If RFP_IN has 'Change of Payment Allowed' option enabled, the requested amount can be changed and accepted
{
    "acceptedAmount": {
        "amount": 1500,
        "currency": "USD"
    },
    "referenceNumber": "20230823267084131Rt8aAvv4ElXYgwm",
    "status": "ACTC"
}

Request Body for TCH

{
    "processor": "TCH",
    "referenceNumber": "M20240319111112222T1BTST62015255801 ",
    "status": "RJCT",
    "reason": {
        "code": "AC06",
        "additionalInfo": "Account Closed"
    }
}

Response: 200

Response Parameters

Parameter	Description
response	String Response received for the given request Example – "JSON Representation of Received Response"
message	String Notification message for the request Example – "request submitted successfully"
rawMessage	String Raw response message related to the transaction encoded in Base64 Example – "Base64 Value of Received Response"
status	String Status of the response Example – "RCVD"

Response Body (Applicable for both FedNow and TCH)

{
  "response": "JSON Representation of Received Response",
  "message": "request submitted successfully",
  "rawMessage": "Base64 Value of Received Response",
  "status": "RCVD"
}