Get Funding Entry by Reference

Get funding by reference number.

Definition

URL

GET https://api-test.instarem.com:4803/api/v1/fund/reference/{gl_reference_number}

Header Parameters

Parameter	Description	Type	Required
authorization	Authentication Token	String	Yes
content-type	The Content-Type entity header is used to indicate the media type of the resource. Expected value is application/json.	String	Yes
X-CLIENT-ID	Unique id for client generated by Nium, Required only in case of partner based model (E.g. 593feb7c7c52bb2357b2df6c).	String	No

Example Request

Bash

curl --request get \\
--url "https://api-test.instarem.com:4803/api/v1/fund/reference/{gl_reference_number}" \\

--header 'authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0OTgxMzQ4OTQsImRhdGEiOnsic3ViIjoiNTk0MjNmMzZjZWEyMTQ2OTI2ODczOWE1IiwiY2xpZW50IjoiNTk0MjNmMzZjZWEyMTQ2OTI2ODczOWExIn0sImlhdCI6MTQ5ODA0ODQ5NH0.pevwSDpk-JDNtVIpqFu_m0Xu1UnDVumrAYStcrxf8sM' \\

Javascript

var data = JSON.stringify({})
var xhr = new XMLHttpRequest();
xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});
xhr.open("get", "https://api-test.instarem.com:4803/api/v1/fund/reference/{gl_reference_number}")
xhr.setRequestHeader("authorization", "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0OTgxMzQ4OTQsImRhdGEiOnsic3ViIjoiNTk0MjNmMzZjZWEyMTQ2OTI2ODczOWE1IiwiY2xpZW50IjoiNTk0MjNmMzZjZWEyMTQ2OTI2ODczOWExIn0sImlhdCI6MTQ5ODA0ODQ5NH0.pevwSDpk-JDNtVIpqFu_m0Xu1UnDVumrAYStcrxf8sM");
xhr.send(data);

C#

var client = new RestClient("https://api-test.instarem.com:4803/api/v1/fund/reference/{gl_reference_number}");
var request = new RestRequest(Method.GET);
request.AddHeader("authorization", "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0OTgxMzQ4OTQsImRhdGEiOnsic3ViIjoiNTk0MjNmMzZjZWEyMTQ2OTI2ODczOWE1IiwiY2xpZW50IjoiNTk0MjNmMzZjZWEyMTQ2OTI2ODczOWExIn0sImlhdCI6MTQ5ODA0ODQ5NH0.pevwSDpk-JDNtVIpqFu_m0Xu1UnDVumrAYStcrxf8sM");
request.AddParameter("application/json", @"{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Path Parameters

Parameter	Description	Type	Required
gl_reference_number	Ledger reference number generated by NIUM.	String	Yes

Example Response

{
    "gl_reference_number": "1527766007875",
    "status": "PENDING",
    "amount": 1000.78,
    "currency": "SGD",
    "created_at": "2018-05-31T11:26:47.949+05:30",
    "updated_at": "2018-05-31T11:26:47.949+05:30"
}

Response Parameters

Parameter	Description	Type
gl_reference_ number	Ledger reference number generated by NIUM.	String
status	Current status of the funding entry	String
amount	Amount for which the funding was made	Number
currency	Currency in which the funding was done	String
created_at	Date and time (UTC) of funding.	String
updated_at	Date and time (UTC) of funding.	String