Get Fee

The 'Get Fee' API enables to calculate and retrieve the applicable fees for a specified transaction initiated from an account

Method: POST

{{URL}}/jsonrpc

Headers

Name	Value
Content-Type	application/json

Example

Payload Parameters

Parameter	Description
method Mandatory	String API method that is being called to get fee details through ledger service Constant value – "TransactionService.GetFee"
id Mandatory	String Unique ID of API request Sample value – "1"
params Mandatory	Object
api Mandatory	Object
signature Mandatory	String Signature for request validation Sample value – "signature"
keyId Mandatory	String API key used for request authentication Sample value – "ApplicationKeyId"
credential Mandatory	String API credential provided by NetXD Sample value – "Credential"
payload Mandatory	Object
AccountNumber Mandatory	String Account number of debtor Sample value – "200524894086671"
Type Mandatory	Enum Type of transaction Valid values: REMITTANCE CARDPAY INTERNAL_TRANSFER WITHDRAW DEPOSIT INTERNAL EFT BILLPAY R2P VOID OPENING_BALANCE FEE_REFUND ISSUE_CARD TAX_REFUND BILLPAY_SADAD ACH_OUT ACH_PULL WIRE_OUT DISBURSEMENT KYC_TRANSACTION GL_TRANSFER WIRE_DD ACH_RETURN RTP_OUT RTP_REVERSAL RTP_IN ICS_DEPOSIT RTP_RFR_OUT RTP_RFR_IN FEDNOW_RFP_OUT FEDNOW_RFR_OUT Sample value – "WITHDRAW"
Mode Conditional Mandatory	String Mode of transfer (Mandatory if type is 'WITHDRAW' or 'DEPOSIT') Valid values: PG ACH QRCODE EFT TELLER BENEFIT CHEQUE Sample value – "ACH"
InstructedAmount Mandatory	Object
Amount Mandatory	Number Amount of the transaction Sample value – 900
Currency Mandatory	String Type of currency used for transaction Sample value – "USD"
Program Mandatory	String Program name/id of a customer typically includes the customer ID Sample value – "100000000000005"
Product Mandatory	String Application from where the request in initiated Constant value – "LEDGER"

cURL

curl --location --globoff '{{URL}}/jsonrpc' \
--header 'Content-Type: application/json' \
--data '{"method":"TransactionService.GetFee","id":"1","params":{"api":{"signature":"{{signature}}","keyId":"{{ApplicationKeyId}}","credential":"{{Credential}}"},"payload":{"AccountNumber":"200524894086671","Type":"WITHDRAW","Mode":"ACH","InstructedAmount":{"Amount":900,"Currency":"USD"},"Program":"100000000000005","Product":"LEDGER"}}}'

C#

var options = new RestClientOptions("{{URL}}/jsonrpc")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Post);
request.AddHeader("Content-Type", "application/json");
var body = @"{
" + "\n" +
@"  ""method"": ""TransactionService.GetFee"",
" + "\n" +
@"  ""id"": ""1"",
" + "\n" +
@"  ""params"": {
" + "\n" +
@"    ""api"": {
" + "\n" +
@"      ""signature"": ""{{signature}}"",
" + "\n" +
@"      ""keyId"": ""{{ApplicationKeyId}}"",
" + "\n" +
@"      ""credential"": ""{{Credential}}""
" + "\n" +
@"    },
" + "\n" +
@"    ""payload"": {
" + "\n" +
@"      ""AccountNumber"": ""200524894086671"",
" + "\n" +
@"      ""Type"": ""WITHDRAW"",
" + "\n" +
@"      ""Mode"": ""ACH"",
" + "\n" +
@"      ""InstructedAmount"": {
" + "\n" +
@"        ""Amount"": 900,
" + "\n" +
@"        ""Currency"": ""USD""
" + "\n" +
@"      },
" + "\n" +
@"      ""Program"": ""100000000000005"",
" + "\n" +
@"      ""Product"": ""LEDGER""
" + "\n" +
@"    }
" + "\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}}/jsonrpc"
  method := "POST"

  payload := strings.NewReader(`{`+"
"+`
  "method": "TransactionService.GetFee",`+"
"+`
  "id": "1",`+"
"+`
  "params": {`+"
"+`
    "api": {`+"
"+`
      "signature": "{{signature}}",`+"
"+`
      "keyId": "{{ApplicationKeyId}}",`+"
"+`
      "credential": "{{Credential}}"`+"
"+`
    },`+"
"+`
    "payload": {`+"
"+`
      "AccountNumber": "200524894086671",`+"
"+`
      "Type": "WITHDRAW",`+"
"+`
      "Mode": "ACH",`+"
"+`
      "InstructedAmount": {`+"
"+`
        "Amount": 900,`+"
"+`
        "Currency": "USD"`+"
"+`
      },`+"
"+`
      "Program": "100000000000005",`+"
"+`
      "Product": "LEDGER"`+"
"+`
    }`+"
"+`
  }`+"
"+`
}`)

  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': '/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({
  "method": "TransactionService.GetFee",
  "id": "1",
  "params": {
    "api": {
      "signature": "{{signature}}",
      "keyId": "{{ApplicationKeyId}}",
      "credential": "{{Credential}}"
    },
    "payload": {
      "AccountNumber": "200524894086671",
      "Type": "WITHDRAW",
      "Mode": "ACH",
      "InstructedAmount": {
        "Amount": 900,
        "Currency": "USD"
      },
      "Program": "100000000000005",
      "Product": "LEDGER"
    }
  }
});

req.write(postData);

req.end();

Body

{
  "method": "TransactionService.GetFee",
  "id": "1",
  "params": {
    "api": {
      "signature": "{{signature}}",
      "keyId": "{{ApplicationKeyId}}",
      "credential": "{{Credential}}"
    },
    "payload": {
      "AccountNumber": "200524894086671",
      "Type": "WITHDRAW",
      "Mode": "ACH", 
      "InstructedAmount": {
        "Amount": 900,
        "Currency": "USD"
      },
      "Program": "100000000000005",
      "Product": "LEDGER"
    }
  }
}

Response: 200

Response Parameters

Parameter	Description
id	String Response ID echoed from the request ID Sample value – "1"
result	Object
fee	Object
amount	Number Fee amount for the given instructed amount Sample value – 100
currency	String Currency type of fee amount Sample value – "USD"
tax	Number Tax amount Sample value – 0

{
  "id": "1",
  "result": {
    "fee": {
      "amount": 100,
      "currency": "USD",
      "tax": 0
    }
  }
}