Large Amount Setup

Query the FX large-amount limit configuration.

Request parameters

This dataset exposes no business filter fields; pass an empty filters object. You can still use page, page_size, and orderBy to control pagination and sorting.

Business notes

Maintains large-amount limit rules for currency exchange, applying extra control to conversions above a threshold.

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_amount_configs

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_conversion.amount_config_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.

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated Large Amount Setup 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.

currencystring

Returned value: Currency.

currency_valstring

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

amountstring

Returned value: Large Amount Starting point.

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.

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_amount_configs' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "filters": {},
  "page": 1,
  "page_size": 20
}'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "32026",
        "currency": "SGD",
        "currency_val": "SGD",
        "amount": "2,000.00",
        "created_at": "1783972944",
        "updated_at": "1784170224"
      }
    ],
    "total": 6
  }
}

Export

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

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

lb_hk_conversion.amount_config_query

Export options Export records Download result