Skip to content
Withdrawal - Pending

Direct Withdraw to Expenditure Account

Initiate a direct withdrawal to an expense account, paying out funds per the detail list through the specified bank channel.

Request parameters

  • Required: bank_account_id (Longbridge bank account ID), bank_channels_id (bank channel ID), details (withdrawal detail list)
  • Optional: starting_check_number (starting check number), audit_frontend_resource (audit context)
  • See the field definitions for each field's format, allowed values, and business meaning.

Business notes

This executes a real payout of funds; confirm the account, channel, and every detail.

Risk warning

This operation may change real funds, positions, or transaction state. Confirm the target record and parameters before calling.

Result

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

POSThttps://b-api.lbkrs.com/v1/portfolio/atm/direct/withdraw

Authorization

AuthorizationstringheaderRequired

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

Permission

atm.direct_withdraw

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

Request body application/json

starting_check_numberstring

Starting check number. When paying out by check, the first check serial number assigned to this batch; later details increment from it. A 6-digit number. Required only for check-based withdrawals; omit otherwise.

bank_account_idstringrequired

Receiving bank account ID. First filter the available Longbridge receiving bank accounts by bank name, then select one account's ID.

bank_channels_idstringrequired

Withdrawal channel ID. After selecting a receiving bank account, choose a channel ID from the channels available to that account. Take the key from GET /v1/datasets/refs/withdraw_company_bank_channels whose name starts with the chosen account's short name (e.g. ICBC0012-HKD_网银_FPS).

detailsarray<object>required

Withdraw Detail List. Array element structure: {withdraw_detail_id: withdrawal detail ID, withdraw_detail_serial_no: bank channel serial number}, from the rows selected in the dialog.

Child attributes
withdraw_detail_idstringrequired

Withdraw detail id (id of a row in atm_withdraw_pending_details).

withdraw_detail_serial_nostring

Bank channel serial number of the detail (bank_channel_serial_no); may be empty.

audit_frontend_resourceobject

Audit Context. Audit information automatically attached by the client, including $behavior/$action (single add / batch bulk_add), the account name for bank_account_id, the channel name for bank_channels_id, etc.

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