Skip to content
Longport WhaleLongport Whale
Auto Withdrawal Rules

Edit Out Cash Package Rule

Edit the configuration of an existing automatic-withdrawal rule.

Request parameters

  • Required: id (rule ID), config (rule configuration).
  • Optional: front_payload (display configuration data), audit_frontend_resource (caller-provided audit context).
  • id locates the target rule; config carries the full configuration in the same shape as the create endpoint.
  • See the individual field descriptions for each field's format, allowed values, and business meaning.

Risk warning

This changes a real automatic-withdrawal rule and may affect how customer withdrawals are auto-processed and paid out. Confirm the target rule and configuration before calling.

Result

On success, the automatic-withdrawal rule is updated; the resulting state and returned data follow the 200 response definition.

PUThttps://b-api.lbkrs.com/v1/atm/out/cash/package/rule

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_outcashpackagerule.outcashpackagerule_update

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

Request body application/json

idstringrequired

Rule ID associated with this request.

configobjectrequired

This field is required.

front_payloadobject
audit_frontend_resourceobject

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