Skip to content
Longport WhaleLongport Whale
Transfer-out Request

Audit Transfer-out Application

Reviews securities withdrawal applications, updating a batch of applications to the specified post-review status.

Request parameters

  • Required: ids (withdrawal application ID list), state (post-review status)
  • Optional: remark (remark), is_show (whether the remark is visible to the user), audit_frontend_resource (caller-provided audit context)
  • See the field descriptions for the format, value range, and business meaning of each field.

Business notes

Multiple withdrawal applications can be reviewed in one call. remark is recorded with the review result and is_show controls whether it is shown to the customer.

Risk warning

This operation changes the live review status of withdrawal applications and affects subsequent transfer-out processing. Confirm the target applications and target status before calling.

Result

On success, the selected withdrawal applications are updated. The resulting state and returned data follow the 200 response definition.

POSThttps://b-api.lbkrs.com/atm/transfer/out/update

Authorization

AuthorizationstringheaderRequired

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

Permission

atm.transfer_out_update

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

Request body application/json

idsarray<string>required

Transfer-out Request IDs. Submit Transfer-out Request IDs as a JSON array. This field is required.

remarkstring

Remark. For the approve/submit_channel scenarios this maps to the "Remark" text area; in the reject scenario there is additionally a default-remark dropdown that can populate this field.

statenumberrequired

Resulting State. Determined by action: approve → 1 (processing / PROCESSING_STATE), reject → 3 (rejected / REJECTED_STATE), submit_channel → 2 (processed / PROCESSED_STATE).

is_shownumber

Remark Visible to User. Only passed in the reject scenario: 1 = visible, 0 = hidden; passed as null in the approve/submit_channel scenarios.

Values
1
Visible
0
Invisible
audit_frontend_resourceobject

Audit Context. A tracking object containing $action (approve/reject/add) and $behavior (action description text); not a business field.

Responses

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

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