Skip to content
Longport WhaleLongport Whale
File Sending

Reset Downstream File

Reset one or more tenant clearing files.

Request parameters

  • Required: ids (file record ID list)
  • Optional: audit_frontend_resource (caller-provided audit context)
  • See each field description for format, value range, and business meaning.

Business notes

ids is submitted as a JSON array; one or more clearing file records can be reset so they can be regenerated or resent.

Risk warning

This operation resets the state of clearing files. Confirm the target file records before calling.

Result

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

POSThttps://b-api.lbkrs.com/ob_file/reset_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

idsarray<string>required

Submit File IDs as a JSON array. This field is required.

audit_frontend_resourceobject

Provides audit context for this operation.

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