Lock FX rate

Send rate signature as instruction to lock & held.

Definition

URL

POST https://api-test.instarem.com:4803/api/v1/lockFx/lockFxRate

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/lockFx/lockFxRate" \\
--header 'authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0OTgxMzQ4OTQsImRhdGEiOnsic3ViIjoiNTk0MjNmMzZjZWEyMTQ2OTI2ODczOWE1IiwiY2xpZW50IjoiNTk0MjNmMzZjZWEyMTQ2OTI2ODczOWExIn0sImlhdCI6MTQ5ODA0ODQ5NH0.pevwSDpk-JDNtVIpqFu_m0Xu1UnDVumrAYStcrxf8sM' \\
--header 'content-type: application/json' \\
--data '{
  "rate_signature": "TYY9KqN7PYLG+ynsN67bmwBsFLbtQU3Nud0T0PS1tnEU7SDuf5oTMzqEprHq53k+XZrTEHJVkaBaOH14agsDy_j1xxQbooimihQ6JCV0HhjOz80ioCbaJjQb8Mp1otH9mDiF1Fe29ibiaSAsrEoMByD9PzcWU1TMJlqxBxvnRK73S7SaP_DqP4Ck7dbOEY4a4+haUxZgJXMyQinztHM9jpEgsQ9JxX_cmKjNH03C_JclgBATP4Qz+FfBb1iAgFyE+ZEUlSgO4siDWjswB0XVKc6LeL1ykC9_JhX0WclHSbXVK1vWsMIWcx6NxYlxRiJy2N8E5Jac"
}'

Javascript

var data = JSON.stringify({
  "rate_signature": "TYY9KqN7PYLG+ynsN67bmwBsFLbtQU3Nud0T0PS1tnEU7SDuf5oTMzqEprHq53k+XZrTEHJVkaBaOH14agsDy_j1xxQbooimihQ6JCV0HhjOz80ioCbaJjQb8Mp1otH9mDiF1Fe29ibiaSAsrEoMByD9PzcWU1TMJlqxBxvnRK73S7SaP_DqP4Ck7dbOEY4a4+haUxZgJXMyQinztHM9jpEgsQ9JxX_cmKjNH03C_JclgBATP4Qz+FfBb1iAgFyE+ZEUlSgO4siDWjswB0XVKc6LeL1ykC9_JhX0WclHSbXVK1vWsMIWcx6NxYlxRiJy2N8E5Jac"
});
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/lockFx/lockFxRate");
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/lockFx/lockFxRate");
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", @"{
  ""rate_signature"": ""TYY9KqN7PYLG+ynsN67bmwBsFLbtQU3Nud0T0PS1tnEU7SDuf5oTMzqEprHq53k+XZrTEHJVkaBaOH14agsDy_j1xxQbooimihQ6JCV0HhjOz80ioCbaJjQb8Mp1otH9mDiF1Fe29ibiaSAsrEoMByD9PzcWU1TMJlqxBxvnRK73S7SaP_DqP4Ck7dbOEY4a4+haUxZgJXMyQinztHM9jpEgsQ9JxX_cmKjNH03C_JclgBATP4Qz+FfBb1iAgFyE+ZEUlSgO4siDWjswB0XVKc6LeL1ykC9_JhX0WclHSbXVK1vWsMIWcx6NxYlxRiJy2N8E5Jac""
}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Body Parameters

Parameter	Description	Type	Required
rate_signature	A string containing the encrypted rate details.	String	Yes

Example Response

{
    "fx_hold_id": "bf07da86-d6d5-47a4-b3c6-b77203b298e1",
    "source_currency": "USD",
    "destination_currency": "EUR",
    "fx_rate": 64.1874,
    "hold_expiry_at": ""
}

Response Parameters

Parameter	Description	Type
fx_hold_id	Hold ID	String
source_currency	Source currency (3-letter ISO-4217 code).	String
destination_currency	Destination currency (3-letter ISO-4217 code).	String
fx_rate	Instarem FX rate.	Number
hold_expiry_at	Datetime of the hold expiry.	String