Get Payment Status

The GetPaymentStatus API enables to request for getting the status of both inbound and outbound transactions.

Method: POST

{{URL}}/rtp/rpc/TransactionService/GetPaymentStatus

Headers

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

Example

Payload Parameters

Parameter	Description
referenceNumber Mandatory	String Reference number of inbound transaction Example – "M202311099876665149078836447"
fedNow Mandatory (Applicable only for TCH)	Boolean Fetching status from FedNow service or from Receiver Financial Institution true – from FedNow service false – from Receiver Financial Institution Example – false
processor Mandatory	String Payment channel through which the transaction happens Example – "TCH" or "FedNow"

cURL

curl --location '{{URL}}/rtp/rpc/TransactionService/GetPaymentStatus' \
--header 'Content-Type: application/json' \
--data '{"referenceNumber":"M202311099876665149078836447","processor":"TCH"}'

C#

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

  payload := strings.NewReader(`{`+"
"+`
    "referenceNumber": "M202311099876665149078836447",`+"
"+`
    "processor": "TCH"`+"
"+`
}`)

  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/GetPaymentStatus',
  '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({
  "referenceNumber": "M202311099876665149078836447",
  "processor": "TCH"
});

req.write(postData);

req.end();

Request Body (Applicable for both FedNow and TCH)

{
    "referenceNumber": "M202311099876665149078836447",
    "fednow": false,  //applicable only for FedNow
    "processor": "TCH"
}

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 – "Successfully"
transactionID (Applicable only for TCH)	String Unique ID generated for the transaction Example – "20240319026013673T1BQCQ051004275801"
endToEndId (Applicable only for TCH)	String ID that enables to trace the transaction at any time during the process Example – "M202311099876665149078836447"
instructingId (Applicable only for TCH)	String Payment reference ID of the transaction Example – "20240319026013673T1BQCQ051004275801"
messageId (Applicable only for TCH)	String Unique message ID generated for the transaction Example – "M20240328026013673T1BF1500306903611"
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 (Applicable only for TCH)	String Date and time of the transaction was processed Example – "2024-03-28T09:02:40"
settlementDate (Applicable only for TCH)	String Date and time of the transaction was completed Example – "2024-03-19T00:00:00Z"
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": "Successfully",
  "transactionID": "20240319026013673T1BQCQ051004275801", //applicable only for TCH
  "endToEndId": "M202311099876665149078836447", //applicable only for TCH
  "instructingId": "20240319026013673T1BQCQ051004275801", //applicable only for TCH
  "messageId": "M20240328026013673T1BF1500306903611", //applicable only for TCH
  "rawMessage": "Base64 Value of Received Response",
  "status": "ACTC",
  "acceptedDate": "2024-03-28T09:02:40", //applicable only for TCH
  "settlementDate": "2024-03-19T00:00:00Z", //applicable only for TCH
  "windowId": "001" //applicable only for TCH
}