Skip to content
Longport WhaleLongport Whale
FX Pool Limit Configuration

Modify Exchange Balance

Edit an FX-pool quota configuration.

Request parameters

  • Required: id (config ID), params (configuration content)
  • Optional: audit_frontend_resource (caller-provided audit-log payload)
  • See each field's definition for its format, value range, and business meaning.

Business notes

id is taken from the target record; params follows the same structure as "Create FX-pool quota configuration" (including currency).

Risk warning

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

Result

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

POSThttps://b-api.lbkrs.com/atm/modify/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

idstringrequired

Taken from the row data record.id.

paramsobjectrequired

Same as "Add Large FX Configuration": currency (disabled/uneditable when editing), alarm_amount, remaining_amount, and remark.

Child attributes
currencystring

Currency (not editable when editing).

alarm_amountnumber

Alarm threshold amount.

remaining_amountnumber

Remaining amount adjustment.

remarkstring

Remark.

audit_frontend_resourceobject

Taken from the row data record before editing; not a business field.

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