Skip to content
Longport WhaleLongport Whale
File Sending

Batch Send Downstream Files

Send tenant clearing files in bulk.

Request parameters

  • Required: ledger_date (ledger date), market (market)
  • Optional: file_code (file type)
  • See each field description for format, value range, and business meaning.

Business notes

Sends clearing files in bulk for the scope defined by ledger_date and market; file_code can further restrict the file type.

Risk warning

This operation actually sends clearing files downstream in bulk. Confirm the scope before calling; previewing the number of pending files first is recommended.

Result

On success the clearing files are sent in bulk; refer to the 200 response for the resulting state and returned data.

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

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

ledger_datenumberrequired

This field is required.

marketstringrequired

This field is required.

file_codestring

file_code. Values come from a backend data dictionary (maintained dynamically), not a fixed enum; use the options the service actually returns.

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