Update Rate Reference

Edit a reference-rate configuration, used to change a reference rate's channel, currency pair, and spread settings.

Request parameters

Required: id (reference-rate record ID), channel_name (FX channel), from_currency, to_currency, spread_mode, bp (spread value)
Optional: audit_frontend_resource (audit snapshot with the pre-edit original data)
See each field's definition for its format, value range, and business meaning.

Business notes

Allowed values for channel_name come from the ref spot_forex_sources; those for from_currency and to_currency come from the ref tenant_currencies_for_exchange and are mutually exclusive. Allowed values for spread_mode come from the ref forex_spread_mode. bp ranges from 0 to 100 with up to 4 decimal places.

Risk warning

This operation changes a reference rate and its spread configuration, directly affecting the calculation of executed FX prices. Confirm the target record and parameters before calling.

Result

On success the reference-rate configuration is updated; see the 200 response definition for the returned content.

POSThttps://b-api.lbkrs.com/forex/rate_reference_update

Authorization

AuthorizationstringheaderRequired

Send the Broker ACCESS_TOKEN as Authorization: Bearer <token>.

Permission

lb_hk_conversion.rate_reference_update

The Broker ACCESS_TOKEN must be granted the permission above, or the call will be rejected.

Request body application/json

idstringrequired

The ID of the reference-exchange-rate record to edit, taken from the list row data; required when editing.

channel_namestringrequired

The rate-source channel code; the allowed values come from ref spot_forex_sources.

from_currencystringrequired

A three-letter currency code; the allowed values come from the caller ref tenant_currencies_for_exchange.

to_currencystringrequired

Three-letter currency code; the allowed values come from the caller ref tenant_currencies_for_exchange, and it is mutually exclusive with from_currency.

spread_modestringrequired

Enum from the caller ref forex_spread_mode; in client logic, when the value is RATE the markup is by percentage (%), otherwise the markup is a fixed value.

Values

VALUE: Value
RATE: Ratio

bpstringrequired

Range 0-100, up to 4 decimal places (client validation regex /^\d+(.\d{1,4})?$/); when spread_mode is RATE it means a percentage markup, otherwise a fixed-value markup.

audit_frontend_resourceobject

A snapshot of the original record before editing (client originData/queryData), used only for back-office audit trail; not a business field.

Responses

HTTP 200The request was processed successfully. The response data does not contain additional business fields.