Skip to content
Longport WhaleLongport Whale
Deposit Parameter

Query Group Deposit Config

Fetches details for one or more group deposit configurations by their ids.

Request parameters

  • Required: ids (configuration ID list)
  • See the field definitions for each field's format, value range, and business meaning.

Returns

On success returns the details of the matching configurations; see the response definition for field meanings.

POSThttps://b-api.lbkrs.com/v2/atm/group/deposit/config/query

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_depositconfig.depositconfig_query

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

Request body application/json

idsarray<string>required

Config ids. Specifies Config ids. This field is required.

Responses

HTTP 200The request was processed successfully. data is the result.
Standard response envelopecodemessagedata
dataobjectdata structure
groupDepositConfigsarray<object>

Group deposit configs. Specifies Group deposit configs.

Child attributes
company_idinteger

Company id. Specifies Company id.

account_channelstring

Account channel. Specifies Account channel.

region_idinteger

Region id. Specifies Region id.

region_bank_idinteger

Region bank type. Specifies Region bank type.

region_bank_idsarray<string>

Region bank ids. Specifies Region bank ids.

bank_operation_types_idinteger

Bank operation type id. Specifies Bank operation type id.

auth_statestring

Auth state. Specifies Auth state.

weightstring

Weight. Specifies Weight.

currency_banksarray<object>

Currency-bank configs. Specifies Currency-bank configs.

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. Specifies Priority.

language_guidesarray<object>

Language guides. Specifies Language guides.

Child attributes
languagestring

Language. Specifies Language.

guide_config_idstring

Guide config id. Specifies Guide config id.

idsarray<string>

Config IDs. Returned value: Config IDs this record corresponds to.

group_idstring

Group ID. Returned value: Group identifier of the group deposit config.

org_idstring

Organization ID. Returned value: ID of the organization the config belongs to.

company_textstring

Company name. Returned value: Company name for company_id.

regionstring

Region code. Returned value: Region code.

region_textstring

Region name. Returned value: Region name for region_id.

region_bank_textstring

Region bank name. Returned value: Display name of the region bank; may be an empty string.

bank_operation_types_textstring

Bank operation type name. Returned value: Deposit method name for bank_operation_types_id.

currenciesstring

Currencies. Returned value: Currencies covered by the config.

currency_banks_textstring

Currency-bank display text. Returned value: Display text of the currency-bank settings; may be an empty string.

lb_bank_account_idstring

Remittance bank. Returned value: Remittance bank account ID.

open_lb_bank_account_idstring

Account-opening deposit bank account ID. Returned value: Receiving bank account ID for account-opening deposits.

fps_account_nostring

FPS account number. Returned value: FPS account number.

fee_payerstring

Fee payer. Returned value: Fee payer (display value).

edda_auth_typeinteger

eDDA auth type. Returned value: eDDA authorization type (integer code).

edda_auth_type_textstring

eDDA auth type name. Returned value: Display text of edda_auth_type; may be an empty string.

prioritystring

Priority. Returned value: Config priority (numeric string).

language_guides_jsonstring

Language guides JSON. Returned value: Language guide settings as a JSON string.

language_guides_textstring

Language guides display text. Returned value: Display text of the language guides; may be an empty string.

stateinteger

State. Returned value: Listing state of the config (integer code); see state_text for the display text.

state_textstring

State name. Returned value: Display text of state.

audit_statusstring

Audit status. Returned value: Audit status of the config; may be an empty string.

ticket_idstring

Ticket ID. Returned value: Associated approval ticket ID; may be an empty string.

created_at_unixstring

Created at. Returned value: Creation time, Unix timestamp in seconds, returned as a string.

updated_atstring

Updated at. Returned value: Update time, formatted YYYY-MM-DD HH:mm:ss.

updated_at_unixstring

Updated at (timestamp). Returned value: Update time, Unix timestamp in seconds, returned as a string.

pageobject

Pagination. Returned value: Pagination information.

Child attributes
page_nointeger

Current page number.

page_sizeinteger

Page size.

total_countinteger

Total number of matching records.

total_pageinteger

Total number of pages.

first_pageinteger

First page number.

last_pageinteger

Last page number.

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