Add Group Deposit Config

Creates a group deposit configuration that organizes deposit parameters (currency-to-bank mappings and multilingual guides) by account channel, company, region, region bank type, and deposit method.

Request parameters

Required: account_channel, company_id, region_id, region_bank_id (region bank type), bank_operation_types_id, auth_state, currency_banks (currency-to-bank list), weight
See the field definitions for each field's format, value range, and business meaning.

Business notes

weight controls the display ordering of configurations in the same group.
currency_banks defines the receiving bank details for each currency.

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/v3/atm/group/deposit/config

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_depositconfig.depositconfig_group_update

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

Request body application/json

region_idintegerrequired

Region id. Specifies Region id. This field is required.

region_bank_idsarray<string>

Region bank ids. Specifies Region bank ids.

bank_operation_types_idinteger

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

auth_statestring

Auth state.

Allowed values: 0 Not enabled, 1 Unauthenticated/Pending authentication, 2 Authenticated

Values

0: Not enabled
1: Unauthenticated
2: Authenticated

currency_banksarray<object>

Currency-bank configs. Specifies Currency-bank configs. This field is required.

Child attributes

currenciesstring

Currency. Specifies Currency.

lb_bank_account_idstring

Remittance bank. Specifies Remittance bank.

open_lb_bank_account_idstring

Guide remittance bank. Specifies Guide remittance bank.

prioritystring

Priority. A free-form value (not an enum); provide the actual business value.

weightstring

Weight. Specifies Weight. This field is required.

language_guidesarray<object>

Language guides. Specifies Language guides.

Child attributes

languagestring

Language. Specifies Language.

guide_config_idstring

Guide config id. Specifies Guide config id.

org_idintegerrequired

Org id. Specifies Org id.

audit_frontend_resourceobject

Caller-provided audit context. Specifies Caller-provided audit context.

fps_account_nostring

FPS account number

edda_auth_typestring

eDDA authorization type; options come from a backend data dictionary

fee_payerstring

Fee-bearing party; options come from a backend data dictionary

Responses

HTTP 200The request was processed successfully. The response data does not contain additional business fields.