Skip to content
Add Rate Configuration

Update Rate Reference

Update Rate Reference.

Request parameters

  • Required: id (Rate Reference ID), channel_name (Exchange Channel), from_currency (From Currency), to_currency (To Currency), spread_mode (Spread Mode), bp (Spread Value)
  • Optional: audit_frontend_resource (Audit Frontend Resource (Before Edit))
  • See each field for its format, allowed values, and business meaning.

Result

On success, the endpoint completes the operation. See the 200 response schema for returned data and subsequent state information.

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

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 dropdown options come from ref spot_forex_sources.

from_currencystringrequired

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

to_currencystringrequired

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

spread_modestringrequired

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.

Allowed values:

  • VALUE - Value
  • RATE - Ratio

VALUE · ValueRATE · Ratio

bpstringrequired

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

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 200The request was processed successfully. The response data does not contain additional business fields.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 400Bad request. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 401The user is not authenticated, or the login session has expired.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 403The current account is not authorized to use this feature. Grant the required permission to the account in User Permission.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 408The request timed out. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

Whale Docs