Add Rate Configuration

Query the reference-rate spread (markup) configuration.

Request parameters

Combine business filter conditions through filters (see the filter-field descriptions below), and use page, page_size, and orderBy to control pagination and sorting.

Business notes

Maintains markup rules on the reference rate — exchange channel, from/to currency, markup mode, markup value, operator and version; used to derive the customer rate from the reference rate.

Returns

On success, returns the matching record list with pagination information. See the response schema for the meaning of each returned column.

POSThttps://b-api.lbkrs.com/v1/datasets/atm_forex_rate_references

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_conversion.fee_query

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

Request body application/json

filtersobject

Combines business filters. Omit a filter field to disable that filter.

Child attributes

channel_namestring

Filters results by Exchange Channel.

Values are dynamic. Call GET /v1/datasets/refs/forex_channel to retrieve the current data dictionary, and use the returned entry's key as this parameter's value.

spread_modestring

Filters results by Spread Setup.

Allowed values: VALUE Value, RATE Ratio

Values

VALUE: Value
RATE: Ratio

idstring

Filters results by Ref Spread Setup ID.

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated Add Rate Configuration records together with pagination metadata such as the page number, page size, and total record count.

Standard response envelopecodemessagedata

dataobjectdata structure

listarray<object>required

Returned value: List of list.

Child attributes

idstring

Returned value: Unique identifier of the current record.

channel_namestring

Returned value: Exchange Channel.

from_currencystring

Returned value: Debit Currency.

from_currency_valstring

Raw value of from_currency. The from_currency field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

to_currencystring

Returned value: Credit Currency.

to_currency_valstring

Raw value of to_currency. The to_currency field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

spread_modestring

Returned value: Spread Setup.

spread_mode_valstring

Raw value of spread_mode. The spread_mode field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

bpstring

Returned value: BP.

created_atstring

Returned value: Created Time. The date or time format follows the value returned by the API.

updated_atstring

Returned value: Updated Time. The date or time format follows the value returned by the API.

action_userstring

Returned value: Action User.

versionstring

Returned value: Version.

totalintegerrequired

Returned value: Total number of matching records, used for pagination.

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

Request

curl --request POST \
  --url 'https://b-api.lbkrs.com/v1/datasets/atm_forex_rate_references' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "filters": {},
  "page": 1,
  "page_size": 20
}'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "209742",
        "channel_name": "MANUAL_CURRENT",
        "from_currency": "AUD",
        "from_currency_val": "AUD",
        "to_currency": "HKD",
        "to_currency_val": "HKD",
        "spread_mode": "Value",
        "spread_mode_val": "VALUE",
        "bp": "1",
        "created_at": "1784168979",
        "updated_at": "1784168979",
        "action_user": "user@example.com",
        "version": "2"
      }
    ],
    "total": 10
  }
}

Export

The export endpoint uses the same filters as this Dataset query.

POSThttps://b-api.lbkrs.com/v1/datasets/atm_forex_rate_references/download

lb_hk_conversion.fee_query

Export options Export records Download result