Get Book FX

Get Book FX details by confirmation id.

Definition

URL

GET https://api-test.instarem.com:4803/api/v1/bookfx/{confirmation_id}

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/bookfx/{confirmation_id}" \\

--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/bookfx/{confirmation_id}")
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/bookfx/{confirmation_id}");
 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

Parameter	Description	Type	Required
confirmation_id	Confirmation ID created at the time of Book fx.	String	Yes

Example Response

{
    "confirmation_id": "USD-MYR-SJtfvAOQb",
    "buy_amount": 14921.71,
    "sell_amount": 3478.7,
    "from_account": 101950173983,
    "to_account": 101950173170,
    "buy_currency": "MYR",
    "sell_currency": "USD",
    "instarem_fx_rate": 4.2556,
    "fx_rate": 4.277,
    "margin_percent": 0.5,
    "margin_value": 0.17323,
  	"status": "OPEN",
    "created_at": "2017-06-22T05:35:13.387Z",
    "expiry_at": "2017-04-12T06:33:30.887Z"
}

Response Parameters

Parameter	Description	Type
confirmation_id	Returns the unique confirmation ID generated by Instarem for successful Book Fx.	String
buy_amount	Returns a requested amount or a computed amount.	Number
sell_amount	Returns a requested amount or a computed amount.	Number
from_account	Returns 12 digit account number for a specified buy currency generated by Instarem.	Number
to_account	Returns 12 digit account number for a specified buy currency generated by Instarem.	Number
buy_currency	Return buy currency (3-letter ISO-4217 code).	String
sell_currency	Return sell currency (3-letter ISO-4217 code).	String
instarem_fx_ rate	Returns Instarem FX rate.	Number
fx_rate	Returns real time FX provider rate	Number
margin_percent	Returns margin percent as specified in the agreement for the book FX pair.	Number
margin_value	Returns computed margin value for the book FX pair.	Number
status	Status of the trade. Valid values are OPEN, EXPIRED and EXECUTED	String
created_at	Date and time (UTC) of book FX.	String
expiry_at	Date and time (UTC) when book FX expires.	String