Skip to content
Longport WhaleLongport Whale
Add Rate Configuration

Update User Rate

Update User Rate.

Request parameters

  • Required: id (Config ID), end_time (End Time), start_time (Start Time), from_currency (From Currency), to_currency (To Currency), default_effective (Default Effective)
  • Optional: action_user (Action User), channel_name (Channel Name), is_default (Is Default), rate_source (Rate Source), rate_use_in (Rate Use In), reference_rate (Reference Rate), service_strategy (Service Strategy), spread_mode (Spread Mode), spread_value (Spread Value), 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.lbkrs.com/forex/user_rate_update

Production: https://b-api.lbkrs.com · Test: https://b-api.longbridge.xyz

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_conversion.fee_update

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

Request body application/json

idstringrequired

Config ID associated with this request.

action_userstring
channel_namestring

Removed before submission (not sent) when service_strategy=BATCH (batch strategy).

end_timestringrequired

For a custom effective period, pass the range picker's end_time as a Unix timestamp in seconds. For the default period, pass 0.

start_timestringrequired

Same logic as end_time.

from_currencystringrequired

This field is required.

to_currencystringrequired

This field is required.

is_defaultstring
rate_sourcestring
rate_use_instring
reference_ratestring
service_strategystring
spread_modestring
spread_valuearray<string>

Array elements {start_value, end_value}, split from the request field range_value interval.

default_effectivestringrequired

This field is required.

audit_frontend_resourceobject

Provides audit context for this operation.

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