Skip to content
Longport WhaleLongport Whale
Withdrawal - Pending

Add Withdrawal Remark

Add or update a remark on a withdrawal application (v2), optionally with a remark template and attachments.

Request parameters

  • Required: id (withdrawal application ID), remark (remark), type (business type, e.g. withdrawApplication)
  • Optional: remark_config_type (predefined remark type), file_keys (attachment file key list)
  • See the field definitions for each field's format, allowed values, and business meaning.

Result

On success the operation completes; refer to the 200 response for the resulting state and data.

POSThttps://b-api.lbkrs.com/v2/atm/modify/withdraw/remark

Authorization

AuthorizationstringheaderRequired

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

Permission

atm.add_withdraw_remark

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

Request body application/json

idstringrequired

Withdraw application id. Specifies Withdraw application id. This field is required.

remarkstringrequired

Remark. Specifies Remark. This field is required.

remark_config_typestring

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

typestringrequired

Business type.

Values
withdrawApplication
Withdraw application
file_keysarray<string>

Attachment file keys. Specifies Attachment file keys.

Responses

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

This is a write operation; on success it returns no business data, and data is always 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