Skip to content
Longport WhaleLongport Whale
File Sending

Send Downstream File

Send a single tenant clearing file.

Availability

The backend currently rejects this endpoint as deprecated and returns error 500009. To send tenant clearing files by ledger date and market, use Batch Send Downstream Files (batch_send_downstream_files).

Request parameters

  • Required: id (file record ID)
  • See each field description for format, value range, and business meaning.

Business notes

Locates one clearing file record by id and sends it downstream.

Risk warning

This operation actually sends the clearing file downstream. Confirm the target file record before calling.

Result

On success the clearing file is sent; refer to the 200 response for the resulting state and returned data.

POSThttps://b-api.lbkrs.com/ob_file/send_downstream_file

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_clearing.ob_file_sending_operation

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

Request body application/json

idnumberrequired

File ID associated with this request.

Responses

HTTP 200The request was processed successfully. The response data does not contain additional business fields.
Standard response envelopecodemessagedata
dataobjectdata structure

On success data is an empty object.

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