Skip to content
Longport WhaleLongport Whale
Idle Cash

Enable/Disable Idle Cash Product

Enable or disable an idle-cash product.

Request parameters

  • Required: id (product ID), state (status).
  • See the field definitions for each field's format, allowed values, and business meaning.

Business notes

The product is located by id; state enables or disables it. A disabled product is no longer shown to customers.

Risk warning

This operation changes an idle-cash product's availability to customers. Confirm the product and target state before calling.

Returns

On success the status change is applied; see the 200 response for the exact payload.

POSThttps://b-api.lbkrs.com/admin/funds/change_idle_state

Authorization

AuthorizationstringheaderRequired

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

Permission

fund.idle_money

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

Request body application/json

idnumberrequired

Product ID. Product ID associated with this request.

statenumberrequired

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

Allowed values: 0 Disabled, 1 Enabled

Values
0
Disabled
1
Enabled

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