Skip to content
Longport WhaleLongport Whale
Deposit Guidelines Setups

Add Deposit Guide

Creates a deposit guide that shows customers how to make a deposit for a given account channel, currency, and deposit method.

Request parameters

  • This endpoint has no required parameters; see the field definitions for each field's format, value range, and business meaning.
  • Use account_channel, currencies, and bank_operation_id to scope the guide; content holds the guide body and language selects the language.

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.

POSThttps://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

currenciesstringrequired

Currencies. Specifies Currencies.

guide_typeintegerrequired

Guide Type.

Allowed values: 1 Common guide, 2 Bank-specific guide

Values
1
Common
2
Specified
namestringrequired

Name. Specifies Name.

languagestringrequired

Language. Specifies Language.

bank_operation_idintegerrequired

Bank Operation ID. Values come from a backend data dictionary (maintained dynamically), not a fixed enum; use the options the service actually returns.

org_idstringrequired

Org ID. Specifies Org ID.

audit_frontend_resourceobject

Audit Context. Provides audit context for this operation.

configstringrequired

Guide detail config serialized as a JSON string before submit (vouchers, labels_config, pc/mobile/common, etc.)

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