Skip to content
Longport WhaleLongport Whale
Deposit Guidelines Setups

Edit Deposit Guide

Updates an existing deposit guide identified by id.

Request parameters

  • Required: id (guide configuration ID)
  • The remaining fields match the create operation; see the field definitions for each field's format, value range, and business meaning.

Risk warning

This operation changes customer-facing deposit configuration and may affect the deposit channels and guides users can see. Confirm the target record and parameters before calling.

Result

On success the operation is completed; refer to the 200 response definition for the resulting state and returned data.

PUThttps://b-api.lbkrs.com/atm/guide/config

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_depositguide.depositguide_update

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

Request body application/json

idstringrequired

Guide Config ID. Specifies Guide Config ID. This field is required.

audit_frontend_resourceobject

Audit Context. Provides audit context for this operation.

configobjectrequired

Deposit guide config object containing bank_operation_id, currencies, guide_type, language, name, org_id, plus a JSON-string detail config

Child attributes
bank_operation_idinteger

Bank operation (deposit method) ID.

currenciesstring

Currencies.

guide_typeinteger

Guide type.

languagestring

Language, e.g. en.

namestring

Guide name.

org_idstring

Organization ID.

configstring

Detail config serialized as a JSON string.

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