Skip to content
Longport WhaleLongport Whale
Pending Requests

Update Single Deposit Application State

Change the state of a single deposit application, marking it as credited, failed, cancelled, and so on.

Request parameters

  • Required: id (application ID), state (state)
  • Optional: remark (remark), receivable_amount (receivable amount), audit_frontend_resource (audit context)
  • See the field definitions for each field's format, allowed values, and business meaning.

Business notes

Marking as credited triggers a real crediting of funds; confirm carefully.

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/atm/adminDepositCheck

Authorization

AuthorizationstringheaderRequired

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

Permission

cmbc.hk_user_deposit_application

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

Request body application/json

idstringrequired

Application ID. Application ID associated with this request.

statenumberrequired

State. Target state to set through this request. This field is required.

Allowed values: 0 Processing, 1 Credited, 2 Failed, 3 Cancelled, 4 Voided

Values
0
Processing
1
Booked
2
Failed
3
Revoked
4
Voided
remarkstring

Remark. Specifies Remark.

receivable_amountstring

Receivable Amount. Specifies Receivable Amount.

audit_frontend_resourceobject

Audit Context. 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

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