Create Funding Entry

Create a funding entry.

Definition

URL

POST https://api-test.instarem.com:4803/api/v1/fund/create

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 post \\
--url "https://api-test.instarem.com:4803/api/v1/fund/create" \\
--data {
    "account_number": 101950173983,
    "amount": 1000,
    "instarem_deposit_account": "CIMB-2000496328-USD",
    "payment_reference": "Funding for transactions in USD"
}
--header 'authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0OTgxMzQ4OTQsImRhdGEiOnsic3ViIjoiNTk0MjNmMzZjZWEyMTQ2OTI2ODczOWE1IiwiY2xpZW50IjoiNTk0MjNmMzZjZWEyMTQ2OTI2ODczOWExIn0sImlhdCI6MTQ5ODA0ODQ5NH0.pevwSDpk-JDNtVIpqFu_m0Xu1UnDVumrAYStcrxf8sM' \\
--header 'content-type: application/json' \\

Javascript

var data = JSON.stringify({
    "account_number": 101950173983,
    "amount": 1000,
    "instarem_deposit_account": "CIMB-2000496328-USD",
    "payment_reference": "Funding for transactions in USD"
})
var xhr = new XMLHttpRequest();
xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});
xhr.open("post", "https://api-test.instarem.com:4803/api/v1/fund/create")
xhr.setRequestHeader("authorization", "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0OTgxMzQ4OTQsImRhdGEiOnsic3ViIjoiNTk0MjNmMzZjZWEyMTQ2OTI2ODczOWE1IiwiY2xpZW50IjoiNTk0MjNmMzZjZWEyMTQ2OTI2ODczOWExIn0sImlhdCI6MTQ5ODA0ODQ5NH0.pevwSDpk-JDNtVIpqFu_m0Xu1UnDVumrAYStcrxf8sM");
xhr.setRequestHeader("content-type", "application/json");
xhr.send(data);

C#

var client = new RestClient("https://api-test.instarem.com:4803/api/v1/fund/create");
var request = new RestRequest(Method.POST);
request.AddHeader("authorization", "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0OTgxMzQ4OTQsImRhdGEiOnsic3ViIjoiNTk0MjNmMzZjZWEyMTQ2OTI2ODczOWE1IiwiY2xpZW50IjoiNTk0MjNmMzZjZWEyMTQ2OTI2ODczOWExIn0sImlhdCI6MTQ5ODA0ODQ5NH0.pevwSDpk-JDNtVIpqFu_m0Xu1UnDVumrAYStcrxf8sM");
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", @"{
    ""account_number"": 101950173983,
    ""amount"": 1000,
    ""instarem_deposit_account"": ""CIMB-2000496328-USD"",
    ""payment_reference"": ""Funding for transactions in USD""
}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Body Parameters

Parameter	Description	Type	Required
account_number	12 digit account number as provided by Instarem.	Number	Yes
amount	Amount for which the funding is being made.	Number	Yes
instarem_ deposit _ account	Instarem account used for depositing funds. (Format: BankName-AccountNumber-Currency )	String	Yes
payment_reference	Description for the funding entry	String	Yes

Example Response

{
    "account_number": "101950173983",
    "amount": 1000,
    "currency": "USD",
    "gl_reference_number": "1527252825722",
    "status": "PENDING",
    "created_at": "2018-05-28T06:12:48.216+05:30",
    "updated_at": "2018-05-28T06:12:48.216+05:30"
}

Response Parameters

Parameter	Description	Type
account_number	12 digit account number as provided by Instarem.	String
amount	Amount for which the funding is being made	Number
currency	Currency in which the funding was done	String
gl_reference_number	Ledger reference number generated by Instarem.	String
status	Current status of the funding entry	String
created_at	Date and time (UTC) of funding	String
updated_at	Date and time (UTC) of funding.	String