Transfer against Request For Payment

The PaymentAgainstRequest API enables to transfer the fund for the payment request (RFP_IN) received.

Method: POST

{{URL}}/rtp/rpc/TransactionService/PaymentAgainstRequest

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 – "TCH" or "FedNow"
referenceNumber Mandatory	String Reference number of outbound transaction Example – "REFERENCE123456845"
requestType Mandatory	String Type of inbound request Example – "RFP"
requestReferenceNumber Mandatory	String Reference number of inbound request Example – "M20240325011110756T1BTST17056596311"
instructedAmount Mandatory	Object
amount Mandatory	Number Amount that is transfered for inbound request Example – 753
currency Mandatory	String Currency code of amount Example – "USD"
debtorAccount Mandatory	Object
name Mandatory	String Account name of the sender of transaction Example – "adhithe"
memberId Mandatory	String Bank routing number of the sender of transaction Example – "026013673"
accountNumber Mandatory	String Account number of the sender of transaction Example – "6998802274"
creditorAccount Mandatory	Object
name Mandatory	String Account name of the receiver of transaction Example – "vivek"
memberId Mandatory	String Bank routing number of the receiver of transaction Example – "234567891"
accountNumber Mandatory	String Account number of the receiver of transaction Example – "276512548912"

cURL

curl --location '{{URL}}/rtp/rpc/TransactionService/PaymentAgainstRequest' \
--header 'Content-Type: application/json' \
--data '{"processor":"TCH","referenceNumber":"REFERENCE123456845","requestType":"RFP","requestReferenceNumber":"M20240325011110756T1BTST17056596311","instructedAmount":{"amount":753,"currency":"USD"},"debtorAccount":{"name":"adhithe","memberId":"026013673","accountNumber":"6998802274"},"creditorAccount":{"name":"vivek","memberId":"234567891","accountNumber":"276512548912"}}'

C#

var options = new RestClientOptions("{{URL}}")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("/rtp/rpc/TransactionService/PaymentAgainstRequest", Method.Post);
request.AddHeader("Content-Type", "application/json");
var body = @"{
" + "\n" +
@"    ""processor"": ""TCH"",
" + "\n" +
@"    ""referenceNumber"": ""REFERENCE123456845"",
" + "\n" +
@"    ""requestType"": ""RFP"",
" + "\n" +
@"    ""requestReferenceNumber"": ""M20240325011110756T1BTST17056596311"",
" + "\n" +
@"    ""instructedAmount"": {
" + "\n" +
@"        ""amount"": 753,
" + "\n" +
@"        ""currency"": ""USD""
" + "\n" +
@"    },
" + "\n" +
@"    ""debtorAccount"": {
" + "\n" +
@"        ""name"": ""adhithe"",
" + "\n" +
@"        ""memberId"": ""026013673"",
" + "\n" +
@"        ""accountNumber"": ""6998802274""
" + "\n" +
@"    },
" + "\n" +
@"    ""creditorAccount"": {
" + "\n" +
@"        ""name"": ""vivek"",
" + "\n" +
@"        ""memberId"": ""234567891"",
" + "\n" +
@"        ""accountNumber"": ""276512548912""
" + "\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/PaymentAgainstRequest"
  method := "POST"

  payload := strings.NewReader(`{`+"
"+`
    "processor": "TCH",`+"
"+`
    "referenceNumber": "REFERENCE123456845",`+"
"+`
    "requestType": "RFP",`+"
"+`
    "requestReferenceNumber": "M20240325011110756T1BTST17056596311",`+"
"+`
    "instructedAmount": {`+"
"+`
        "amount": 753,`+"
"+`
        "currency": "USD"`+"
"+`
    },`+"
"+`
    "debtorAccount": {`+"
"+`
        "name": "adhithe",`+"
"+`
        "memberId": "026013673",`+"
"+`
        "accountNumber": "6998802274"`+"
"+`
    },`+"
"+`
    "creditorAccount": {`+"
"+`
        "name": "vivek",`+"
"+`
        "memberId": "234567891",`+"
"+`
        "accountNumber": "276512548912"`+"
"+`
    }`+"
"+`
}`)

  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/PaymentAgainstRequest',
  '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": "REFERENCE123456845",
  "requestType": "RFP",
  "requestReferenceNumber": "M20240325011110756T1BTST17056596311",
  "instructedAmount": {
    "amount": 753,
    "currency": "USD"
  },
  "debtorAccount": {
    "name": "adhithe",
    "memberId": "026013673",
    "accountNumber": "6998802274"
  },
  "creditorAccount": {
    "name": "vivek",
    "memberId": "234567891",
    "accountNumber": "276512548912"
  }
});

req.write(postData);

req.end();

Request Body (Applicable for both FedNow and TCH)

{
    "processor": "TCH",
    "referenceNumber": "REFERENCE123456845",
    "requestType": "RFP",
    "requestReferenceNumber": "M20240325011110756T1BTST17056596311",
    "instructedAmount": {
        "amount": 753,
        "currency": "USD"
    },
    "debtorAccount": {
        "name": "adhithe",
        "memberId": "026013673",
        "accountNumber": "6998802274"
    },
    "creditorAccount": {
        "name": "vivek",
        "memberId": "234567891",
        "accountNumber": "276512548912"
    }
}

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 transaction Example – "Transfered Successfully"
transactionID	String Unique ID generated for the transaction Example – "20240328026013673T1BX5O949100782611"
endToEndId	String ID that enables to trace the transaction at any time during the process Example – "REFERENCE123456846"
instructingId	String Payment reference ID of the transaction Example – "20240328026013673T1BX5O949100782611"
messageId	String Unique message ID generated for the transaction Example – "M20240328026013673T1B9L549100782611"
rawMessage	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 – "ACTC"
acceptedDate	String Date and time of the transaction was processed Example – "2024-03-28T12:25:00"
settlementDate	String Date and time of the transaction was completed Example – "2024-03-28"
windowId (Applicable only for TCH)	String Unique ID used for reconciliation of transactions Example – "001"

Response Body (Applicable for both FedNow and TCH)

{
  "response": "JSON Representation of Received Response",
  "message": "Transfered Successfully",
  "transactionID": "20240328026013673T1BX5O949100782611",
  "endToEndId": "REFERENCE123456846",
  "instructingId": "20240328026013673T1BX5O949100782611",
  "messageId": "M20240328026013673T1B9L549100782611",
  "rawMessage": "Base64 Value of Received Response",
  "status": "ACTC",
  "acceptedDate": "2024-03-28T12:25:00",
  "settlementDate": "2024-03-28",
  "windowId": "001" //applicable only for TCH
}