Skip to content
Deposit Parameter

Check Group Deposit Config

Checks whether a group deposit configuration already exists for a given combination of account channel, company, region, region bank type, and deposit method. Typically used to detect duplicates before creating or editing.

Request parameters

  • Required: company_id, region_id, region_bank_ids (region bank ids), bank_operation_types_id, currency_banks (currency-bank configs)
  • Optional: org_id, weight, auth_state (used on LBHK), ids (config ids to exclude self when editing)
  • region_bank_ids values: specified banks: the selected region bank ids; other banks: [0]; all banks: [999999999]. The backend reads only region_bank_ids; it does not read a scalar region_bank_id and does not need account_channel.
  • When editing, pass ids to exclude the record itself. See the field definitions for each field's format, value range, and business meaning.

Returns

On success returns whether a conflicting configuration exists; see the response definition for field meanings.

POSThttps://b-api.lbkrs.com/v1/atm/check/exist/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

company_idintegerrequired

Company id. Specifies Company id. This field is required.

region_idintegerrequired

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

region_bank_idsarray<integer>required

Region bank ids. This field is required, with at least 1 item. Specified banks: the selected region bank ids; other banks: [0]; all banks: [999999999].

bank_operation_types_idintegerrequired

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
Auth not enabled
1
Unauthenticated
2
Authenticated
weightinteger

Weight. Specifies Weight; pass 0 when not set.

currency_banksarray<object>required

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.

priorityinteger

Priority. An integer; provide the actual business value.

open_lb_bank_account_idstring

Account-opening deposit bank account id. Specifies the receiving bank account for account-opening deposits; omit when not used.

idsarray<string>

Config ids to exclude self (on edit). Specifies Config ids to exclude self (on edit).

org_idinteger

Org id. Specifies Org id.

Responses

HTTP 200The request was processed successfully. data is the result.
Standard response envelopecodemessagedata
dataobjectdata structure
existboolean

Whether config already exists. Specifies Whether config already exists.

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