Skip to content
Client Notification

Update Exchange Rule

Edits the currency-exchange rules used for borrow-reminder scenarios.

Request parameters

  • Required: main (main-currency exchange rule), other (other-currency exchange rule), is_display (whether the rule is shown/enabled)
  • Optional: front_payload (caller-supplied change diff), audit_frontend_resource (caller audit context)
  • See the field definitions for each field's format, allowed values, and business meaning.

Business notes

Configures the exchange rules for the main and other currencies in the borrow-reminder scenario; is_display controls whether the rule is shown/enabled.

Result

On success the exchange-rule configuration is saved; subsequent state and returned data follow the 200 response definition.

POSThttps://b-api.lbkrs.com/v1/risk_monitoring/update_exchange_rule_v2

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

mainobjectrequired

Main Currency Rule. Contains three fields, all numeric strings: debt (debt-amount threshold), avail_with_draw (withdrawable-amount threshold), and currency (the account's base currency, read-only).

otherarray<string>required

Other Currency Rules. An array; each item is {currency: currency code (values from the global_currency_which_support_exchange dynamic enumeration, not fixed), debt: debt-amount threshold, avail_with_draw: withdrawable-amount threshold}; multiple can be added/removed.

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

is_displaybooleanrequired

Is Display. - Single-select

  • on submit the strings 'true'/'false' are converted to booleans
  • when false, the other amount fields are disabled
Values
true
false
front_payloadobject

Front Payload. A non-core business field; type is fixed to data_diff, recording the before/after values of is_display/debt/avail_with_draw/other for approval-ticket display.

audit_frontend_resourceobject

Audit Context. A non-core business field carrying the is_display value at submission time.

Responses

HTTP 200The request was processed successfully. The response data does not contain additional business fields.
Standard response envelopecodemessagedata
dataobjectdata structure
idinteger
ticket_idstring
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