Skip to content
Longport WhaleLongport Whale
FX Pool Limit Configuration

Add Exchange Balance

Create an FX-pool quota configuration.

Request parameters

  • Required: params (configuration content)
  • See each field's definition for its format, value range, and business meaning.

Business notes

params carries the FX-pool quota configuration content (including currency and related information); submitting it creates one FX-pool quota configuration.

Risk warning

This operation adds an FX-pool quota configuration and may affect the quota available for FX business. Confirm the configuration content before calling.

Result

On success the FX-pool quota configuration is created; see the 200 response definition for the returned content.

POSThttps://b-api.lbkrs.com/atm/add/exchange/balance

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_conversion.exchange_pool_config_update

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

Request body application/json

paramsobject
Child attributes
currencystringrequired

Currency

alarm_amountnumberrequired

Alarm threshold amount

remaining_amountnumber

Remaining quota adjustment

remarkstring

Remark

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