Skip to content
Longport Whale
Add Rate Configuration

Update Rate Reference

Submitted from the inline "Edit" dialog on a row of the "Reference Exchange Rate" tab of the Add Rate Configuration page, updating a reference exchange rate configuration.

POSThttps://b-api.longbridge.xyz/forex/rate_reference_update

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

idstringrequired

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

channel_namestringrequired

Exchange Channel. The rate-source channel code; the dropdown options come from ref current_forex_change_type.

from_currencystringrequired

From Currency. A three-letter currency code; the dropdown options come from the front-end ref global_currency_for_exchange.

to_currencystringrequired

To Currency. Three-letter currency code; the dropdown options come from the front-end ref global_currency_for_exchange, and it is mutually exclusive with from_currency.

spread_modestringrequired

Spread Mode. Enum from the front-end ref forex_spread_mode; in front-end logic, when the value is RATE the markup is by percentage (%), otherwise the markup is a fixed value.

bpstringrequired

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

audit_frontend_resourceobject

Audit Frontend Resource (Before Edit). A snapshot of the original record before editing (front-end originData/queryData), used only for back-office audit trail; not a business field.

Responses

HTTP 200No confirmable field definitions are available for the response yet.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

Whale Docs