Create Book Fx By Currency

Create a Book FX using a currency pair of default accounts

The parameters that need to be sent to the service are shared below; Get Fx Rates Request Message Parameters

Parameter
Type
Is Mandatory?
Description

DealerNo

string

It is the dealer number created for the dealer.

Username

string

It is the username created for the dealer.

Password

string

It is the password created for the dealer.

An example JSON object to be sent to the service is as follows:

{
    "Header": {
        "DealerNo": "dealerno",
        "Username": "username",
        "Password": "password"
    }
}

Example Request:

{
    "Header": {
        "DealerNo": "dealerno",
        "Username": "username",
        "Password": "password"
    }
    "SellAmount": 39,
    "Requestid": "1XkQkI34DA",
    "Description": "Postman Deneme 2",
    "BuyCurrency": "USD",
    "SellCurrency": "EUR",
    "BookFxType": "",
    "TotalFxRate":1.067616
}

Body Parameters:

Parameter
Type
Is Mandatory?
Description

SellAmount

decimal

Returns a requested amount or a computed amount.

Requestid

string

A unique Currency Exchange ID specified by the client in the request.

Description

string

Narration for this Book FX request.

BuyCurrency

string

Currency that the client buys (3-letter ISO-4217 code).

SellCurrency

string

Currency that the client sells (3-letter ISO-4217 code).

BookFxType

string

One of ["", PREFUNDING, SCHEDULED1, SCHEDULED2]. Defaults to the client's default FX type if left empty.

Returns Total FX rate.

Example response:

Response Parameters:

Parameter
Type
Is Mandatory?
Description

ConfirmationId

string

Returns the unique Currency Exchange ID generated by Instarem for successful Book Fx.

BuyAmount

decimal

Returns a requested amount or a computed amount.

SellAmount

decimal

Returns a requested amount or a computed amount.

BuyCurrency

string

Currency that the client buys (3-letter ISO-4217 code).

SellCurrency

string

Currency that the client sells (3-letter ISO-4217 code).

TotalFxRate

decimal

Returns real time FX provider rate

ElekseMargin

decimal

Return Elekse Margin

BuyAccountBalance

decimal

Return Buy Account Balance

SellAccountBalance

decimal

Return Sell Account Balance

Status

StatusEnum

SUCCESS = 0, ERROR = 100, FIELD_ERROR = 101, TIME_OUT = 102, CORPORATION_PERMISSION_ERROR = 103, NOT_FOUND = 104,

ERROR_REQUIRECANCELINVOICE = 105, LIMIT_ERROR = 106,

AUTHENTICATION_ERROR = 401, HASNOTPAYMENTS = 999,

Customer_Explanation

string

Return Customer Explanation

LOG_Explanation

string

Return Logs

Last updated