Skip to content
Longport WhaleLongport Whale
File Sending

Generate Downstream File (Batch)

Generates Downstream File (Batch).

Request parameters

  • Required: ledger_date (Ledger Date), market (Market), file_batch (File Batch)
  • 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/ob_file/generate_downstream_file

Authorization

Authorizationstringheaderlb_hk_clearing.ob_file_sending_operationRequired

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

Request body application/json

ledger_datenumberrequired

Specifies Ledger Date. This field is required.

marketstringrequired

Specifies Market. This field is required.

file_batchnumberrequired

Specifies File Batch. This field is required.

Allowed values:

  • 1 - Trade file batch.
  • 2 - Position file batch.
  • 3 - Corporate Action File Batch

1 · Trade file batch.2 · Position file batch.3 · Corporate Action File Batch

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