Get balance by currency

Get available balance for a specific currency.

Definition

URL

GET https://api-test.instarem.com:4803/api/v1/balance/currency/{currency}

Header Parameters

Parameters	Description	Type	Required
authorization	auth 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/balance/currency/{currency}" \\

--header 'authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0OTgxMzQ4OTQsImRhdGEiOnsic3ViIjoiNTk0MjNmMzZjZWEyMTQ2OTI2ODczOWE1IiwiY2xpZW50IjoiNTk0MjNmMzZjZWEyMTQ2OTI2ODczOWExIn0sImlhdCI6MTQ5ODA0ODQ5NH0.pevwSDpk-JDNtVIpqFu_m0Xu1UnDVumrAYStcrxf8sM' \\
--header 'content-type: application/json' \\

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/balance/currency/{currency}")
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/balance/currency/{currency}");
var request = new RestRequest(Method.GET);
request.AddHeader("authorization", "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0OTgxMzQ4OTQsImRhdGEiOnsic3ViIjoiNTk0MjNmMzZjZWEyMTQ2OTI2ODczOWE1IiwiY2xpZW50IjoiNTk0MjNmMzZjZWEyMTQ2OTI2ODczOWExIn0sImlhdCI6MTQ5ODA0ODQ5NH0.pevwSDpk-JDNtVIpqFu_m0Xu1UnDVumrAYStcrxf8sM");
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", @"{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Path Parameters

Parameters	Description	Type	Required
currency	Currency to retrieve available balance e.g: USD (3-letter ISO-4217 code)	String	Yes

Example Response

[
    {
        "account_number": 101950173983,
        "currency": "USD",
        "balance": 50000,
        "auto_bookfx_sequence": 5,
        "active": true,
        "default": true,
        "label": "USD Currency"
    }
]

Response Parameters

Parameters	Description	Type
account_number	Returns 12 digit account number generated by Instarem.	Number
currency	Returns currency (3-letter ISO-4217 code).	String
balance	returns available balance of the account	Number
auto_bookfx_sequence_	If returns <> 0, this account is used for auto book fx, and it's priority is set accordingly.	Number
active	Returns true if account is active otherwise false	Boolean
default	returns true if account is default otherwise false	Boolean
label	returns label name as defined for account	String