Skip to content
Currency Exchange

Batch Estimate Exchange Amounts and Funding Sources

Estimates, in batch, the amount on one side from the source/target currencies and the amount on the other side, and returns the reference exchange rate (including markup). Used to estimate the other amount in real time while the Client enters the source or target amount on the currency exchange page, and to show the amounts in the confirmation dialog before submission.

The request body is the same as POST /v1/atm/calc/multi/estimate/exchange/amount. The difference is that each estimate in the response is wrapped in item and includes cash_used and mmf_redeem. When automatic MMF redemption for currency exchange is enabled, the Broker App uses them to show the cash amount used and the MMF amount to be redeemed in the confirmation dialog (mmf_redeem greater than 0 means the exchange redeems the MMF).

Estimates are for display only; the final amounts are those in the exchange record. If the request fails, show the rate as unavailable and do not submit with a previous estimate.

POSThttps://api.lbkrs.com/v1/forex/calc/multi/estimate/exchange/amount

Request body application/json

paramsarray<object>required

Estimate request items, each with a currency pair and an amount

Child attributes
from_currencystringrequired

Source currency

to_currencystringrequired

Target currency

from_amountstring

Source amount; provide either this or to_amount

to_amountstring

Target amount; provide either this or from_amount

keystring

Record identifier defined by the Broker App and returned unchanged, used to match results to request items

Responses

HTTP 200The request succeeded. The response body contains the result of the “Batch Estimate Exchange Amounts and Funding Sources” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
resultarray<object>

Estimates matching the request params one to one; match them by key

Child attributes
itemobject

Estimate

Child attributes
from_currencystring

Source currency

to_currencystring

Target currency

from_amountstring

Source amount (the estimated source amount when estimating by target amount)

to_amountstring

Target amount (the estimated target amount when estimating by source amount)

keystring

Record identifier from the request, returned unchanged

ratestring

Reference exchange rate, including markup

no_bp_ratestring

Reference exchange rate without markup

bpstring

Markup value

modestring

Markup mode, such as VALUE

cash_usedstring

Portion of the source amount paid from cash

mmf_redeemstring

Portion of the source amount covered by MMF redemption; greater than 0 means the exchange redeems the MMF

Whale Docs