Skip to content
Currency Pairs

Update Support Currency V2

Update Support Currency V2.

Request parameters

  • Required: UpdateSupportCurrency (Support Currency Update List), UpdateSupportCurrency[].from_currency (From Currency), UpdateSupportCurrency[].to_currency (To Currency), UpdateSupportCurrency[].action (Action Type)
  • Optional: UpdateSupportCurrency[].id (Currency Pair Item ID), UpdateSupportCurrency[].default_currency (Is Default Currency), audit_frontend_resource (Audit Frontend Resource (Before/After))
  • See each field for its format, allowed values, and business meaning.

Result

On success, the endpoint completes the operation. See the 200 response schema for returned data and subsequent state information.

POSThttps://b-api.longbridge.xyz/v2/forex/support_currency_update

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

UpdateSupportCurrencyarray<string>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.

UpdateSupportCurrency[].idstring

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

UpdateSupportCurrency[].from_currencystringrequired

Specifies the source currency as a three-letter currency code. Candidate values come from the ref tenant_currencies_for_exchange. This field is required.

UpdateSupportCurrency[].to_currencystringrequired

Specifies the target currency as a three-letter currency code. Candidate values come from the ref tenant_currencies_for_exchange. This field is required.

UpdateSupportCurrency[].actionnumberrequired

Action type. See the options below.

Allowed values:

  • 1 - Add.
  • 2 - Modify / Set as Default
  • 3 - Delete.

1 · Add.2 · Modify / Set as Default3 · Delete.

UpdateSupportCurrency[].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

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