Skip to content
Currency Pairs

Update Support Currency V2

Batch-edit supported FX currency-pair configurations, allowing add, modify, and delete of sub-items in one request, and setting a target currency as default.

Request parameters

  • Required: UpdateSupportCurrency (change list), UpdateSupportCurrency[].from_currency, UpdateSupportCurrency[].to_currency, UpdateSupportCurrency[].action
  • Optional: UpdateSupportCurrency[].id (sub-item ID), UpdateSupportCurrency[].default_currency (whether to set as the default target), audit_frontend_resource (audit snapshot with the before/after target-currency lists)
  • See each field's definition for its format, value range, and business meaning.

Business notes

UpdateSupportCurrency is a change list; each item's action specifies add, modify, or delete. Added items have no id; modified/deleted items must carry the corresponding sub-item id. default_currency marks a target currency as the default exchange target for that source currency.

Risk warning

This operation batch-changes FX currency pairs and the default target currency and may affect the exchange paths and default exchange behavior available to customers. Confirm the change list before calling.

Result

On success the currency-pair configurations are batch-updated; see the 200 response definition for the returned content.

POSThttps://b-api.lbkrs.com/v2/forex/support_currency_update

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_conversion.support_currency_update

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

Request body application/json

UpdateSupportCurrencyarray<object>required

Each item contains id/from_currency/to_currency/action/default_currency; newly added items use action=1, items with a changed to_currency use action=2, and removed old items use action=3; in one case a single item is always passed with action=2 and default_currency=true to set the default target currency.

Child attributes
idstring

The ID of an existing target-currency record; empty when creating (action=1).

from_currencystringrequired

Candidate values come from the ref tenant_currencies_for_exchange. This field is required.

to_currencystringrequired

Candidate values come from the ref tenant_currencies_for_exchange. This field is required.

actionnumberrequired

Action type. See the options below.

Allowed values: 1 Add, 2 Modify / Set as Default, 3 Delete

Values
1
Add.
2
Modify / Set as Default
3
Delete.
default_currencyboolean

Only passed as true in the "Set as Default" scenario.

audit_frontend_resourceobject

Sent only in the edit scenario; contains before/after target-currency arrays, used for back-office audit trails.

Responses

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