Skip to content
Longport WhaleLongport Whale
Large Amount Setup

Add Amount Config

Create an FX large-amount limit configuration, setting the amount threshold that triggers large FX for a currency.

Request parameters

  • Required: currency, amount (large-amount threshold)
  • See each field's definition for its format, value range, and business meaning.

Business notes

Allowed values for currency change with business and are not fixed; call GET /v1/datasets/refs/tenant_currencies_for_exchange to obtain the currently available values. amount is the threshold at which FX in that currency is treated as large.

Risk warning

This operation adds an FX large-amount limit configuration and may affect large-amount determination and handling in FX. Confirm the currency and threshold before calling.

Result

On success the FX large-amount limit configuration is created; see the 200 response definition for the returned content.

POSThttps://b-api.lbkrs.com/forex/amount_config_add

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_conversion.amount_config_update

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

Request body application/json

currencystringrequired

Dropdown selection; value comes from the tenant_currencies_for_exchange dynamic enum, not fixed.

Call GET /v1/datasets/refs/tenant_currencies_for_exchange to retrieve the current data dictionary, and use the returned entry's key as this field's value.

amountnumberrequired

Amount involved in this business operation. This field is required.

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