Skip to content
Longport WhaleLongport Whale
Deposit Guidelines Setups

Edit Deposit Guide

Edit Deposit Guide Config.

Request parameters

  • Required: id (Guide Config ID)
  • Optional: account_channel (Account Channel), currencies (Currencies), guide_type (Guide Type), name (Name), language (Language), bank_operation_id (Bank Operation ID), org_id (Org ID), content (Content), audit_frontend_resource (Audit Context)
  • See each field for its format, allowed values, and business meaning.

Result

On success, the endpoint completes the operation. See the 200 response schema for details.

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.

account_channelstring

Account Channel. Specifies Account Channel.

currenciesstring

Currencies. Specifies Currencies.

guide_typeinteger

Guide Type. Specifies Guide Type.

namestring

Name. Specifies Name.

languagestring

Language. Specifies Language.

bank_operation_idinteger

Bank Operation ID. Specifies Bank Operation ID.

org_idstring

Org ID. Specifies Org ID.

contentstring

Content. Specifies Content.

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

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