Skip to content
Longport WhaleLongport Whale
Data Service Provider

Create / Edit / Delete Settlement Channel Mapping

Creates, edits, or deletes a settlement channel mapping. All three operations share this single endpoint and are distinguished by action_in.

Request parameters

  • Required: action_in (Action In)
  • Optional: id (ID), custodian_id (Broker ID), settlement_channel (Settlement Channel), channel_type (Trade Type), tolerance_threshold (Tolerance Threshold), account_mode (Broker No Filtering), verify_accounts (Broker No), verified (Trade Recon Type), remark (Remark), audit_frontend_resource (audit context)
  • See each field for its format, allowed values, and business meaning.

Business notes

  • Create (action_in=1): omit id and submit the settlement channel mapping business fields.
  • Edit (action_in=3): send the target record's id together with the fields to update.
  • Delete (action_in=2): call the same endpoint with a body of { id, action_in: "2", audit_frontend_resource }, providing only the target record's id and the audit context.

Result

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

POSThttps://b-api.lbkrs.com/clearing/settlement_channels

Production: https://b-api.lbkrs.com · Test: https://b-api.longbridge.xyz

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_clearing.clearing_settlement_channels

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

Request body application/json

action_instringrequired

Specifies Action In. This field is required.

1 · Add2 · Delete3 · Edit

idstring

Settlement channel mapping record ID that identifies the target of this request. Required when editing or deleting.

custodian_idstring

Specifies Broker ID, identifying the broker that owns the settlement channel mapping.

settlement_channelstring
channel_typestring
tolerance_thresholdstring

Channel amount tolerance threshold. Allowed range [0, 1000]; a default of 0 means the tolerance is disabled.

account_modestring
verify_accountsstring
verifiedstring
remarkstring
audit_frontend_resourcestring

Caller-provided audit context used for operation audit logging. The delete operation submits this field together with the request body.

Responses

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