Request For Return Outbound

The ReturnRequest API enables to request for returning the outbound transaction payment.

Method: POST

{{URL}}/PLMASTER/jsonrpc

Headers

Name	Value
Content-Type	application/json

Example

Payload Parameters

Parameter	Description
ID Mandatory	String Unique ID of transaction Example – "112940072"
description Mandatory	String Additional information of the transaction Example – "test"
reasonCode Mandatory	String Code of the reason given to the transaction Example – "CUST"
reason Mandatory	String Reason given to the transaction Example – "Requested By Customer"

cURL

curl --location '{{URL}}/PLMASTER/jsonrpc' \
--header 'Content-Type: application/json' \
--data '{"ID":"112940072","description":"test","reasonCode":"CUST","reason":"Requested By Customer"}'

C#

var options = new RestClientOptions("{{URL}}")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("/PLMASTER/jsonrpc", Method.Post);
request.AddHeader("Content-Type", "application/json");
var body = @"{
" + "\n" +
@"    ""ID"": ""112940072"",
" + "\n" +
@"    ""description"": ""test"",
" + "\n" +
@"    ""reasonCode"": ""CUST"",
" + "\n" +
@"    ""reason"": ""Requested By Customer""
" + "\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}}/PLMASTER/jsonrpc"
  method := "POST"

  payload := strings.NewReader(`{`+"
"+`
    "ID": "112940072",`+"
"+`
    "description": "test",`+"
"+`
    "reasonCode": "CUST",`+"
"+`
    "reason": "Requested By Customer"`+"
"+`
}`)

  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': '/PLMASTER/jsonrpc',
  '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({
  "ID": "112940072",
  "description": "test",
  "reasonCode": "CUST",
  "reason": "Requested By Customer"
});

req.write(postData);

req.end();

Request Body (Applicable for both FedNow and RTP)

{
    "ID": "112940072",
    "description": "test",
    "reasonCode": "CUST",
    "reason": "Requested By Customer"
}

Response: 200

Response Parameters

Parameter	Description
id	String Unique identifier of the request Example – "1"
result	Object
message	String Response message Example – "Transaction Returned Successfully"

Response Body (Applicable for both FedNow and RTP)

{
  "id": "1",
  "result": {
    "message": "Transaction Returned Successfully"
  }
}