Skip to content
Longport WhaleLongport Whale
Currency Pairs

Delete Support Currency

Delete supported FX target-currency records. One call deletes a batch of target currencies under a given source currency.

Request parameters

  • Required: ids (list of target-currency record IDs to delete)
  • Optional: audit_frontend_resource (audit snapshot with the source currency and the deleted target currencies)
  • See each field's definition for its format, value range, and business meaning.

Business notes

ids are taken from the ids of all target-currency sub-items under a source currency, allowing a batch of target currencies under that source to be deleted at once.

Risk warning

This operation removes configured FX currency pairs and may affect the exchange paths available to customers. Confirm the records to delete before calling.

Result

On success the FX currency pairs are deleted; see the 200 response definition for the returned content.

POSThttps://b-api.lbkrs.com/forex/support_currency_delete

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

idsarray<string>required

Use the id values of all target-currency entries under the source currency to delete all of them in one request.

audit_frontend_resourceobject

Contains from_currency (source currency code) and to_currency (array of deleted target currency codes); used only 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