Skip to content
Reference Exchange Rate

Update Reference Exchange Rate

Update Reference Exchange Rate.

Request parameters

  • Required: id (Rate Record ID), channel_name (Channel / Change Type), base_currency (Base Currency), other_currency (Other Currency), record_date (Record Date), bid_rate (Bid Rate), offer_rate (Offer Rate), average_rate (Average Rate)
  • Optional: source (Rate Source), audit_frontend_resource (Audit Context)
  • 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/update

Authorization

Authorizationstringheaderlb_hk_conversion.forex_ib_ratesRequired

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

Request body application/json

idstringrequired

Rate Record ID. The primary key of the reference-exchange-rate record to edit, from the list row's record.id.

sourcestring

Rate Source. A read-only field taken from the record itself; the dropdown enum comes from ref rate_source.

Allowed values: FILE, MANUEL_CREATE (MANUEL CREATE), AUTO, COPY, CCASS (Auto Follow HKEX)

FILEMANUEL_CREATEAUTOCOPYCCASS

channel_namestringrequired

Channel / Change Type. A read-only field (disabled in edit mode); if multi-select, it is joined into a comma-separated string on submission. The dropdown enum comes from ref manual_forex_change_type, e.g. MANUAL_CURRENT/MANUAL_ACCOUNT/CCASS.

Allowed values: MANUAL_CURRENT (Spot rate), MANUAL_ACCOUNT (Ledger rate), CCASS

MANUAL_CURRENTMANUAL_ACCOUNTCCASS

base_currencystringrequired

Base Currency. A read-only field (disabled when editing); defaults to the standard_money currency from atm_currency_config.

other_currencystringrequired

Other Currency. Read-only field (disabled in edit mode).

record_datestringrequired

Record Date. A read-only field (disabled in edit mode); converted by the client to a YYYYMMDD-format string before submission.

bid_ratenumberrequired

Bid Rate. Must be > 0, with precision determined by the rate_precision returned by the getCurrencyRateAccuracy endpoint.

offer_ratenumberrequired

Offer Rate. Must be > 0, with precision determined by the rate_precision returned by the getCurrencyRateAccuracy endpoint.

average_ratenumberrequired

Average Rate. Must be > 0, with precision determined by the rate_precision returned by the getCurrencyRateAccuracy endpoint.

audit_frontend_resourceobject

Audit Context. Audit information attached automatically by the client; in the edit scenario it contains $behavior / $action='edit' / bid_rate / offer_rate / average_rate (the pre-edit old values).

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