Deposit Parameter Setups

Queries Deposit Parameter Setups data. Combine business filters in filters, and use page, page_size, and orderBy to control pagination and sorting.

Response

On success, the API returns the matching records and pagination metadata. See each filter field for its purpose, allowed values, and dynamic value source.

GEThttps://b-api.longbridge.xyz/v1/datasets/atm_group_deposit_configs

This Dataset query is read-only. Use GET by default. If the encoded query parameters are too large, send the same parameters as a JSON body with POST to the same path.

Authorization

Authorizationstringheaderlb_hk_depositconfig.depositconfig_queryRequired

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

Query parameters

filtersobject

Filters. Combines business filters. Omit a filter field to disable that filter.

Child attributes

region_idstring

Bank Region. Filters results by Bank Region.

Values are dynamic. Call GET /v1/datasets/refs/regions_cn_name to retrieve the current data dictionary, and use the returned entry's key as this parameter's value.

region_bank_idstring

Bank Name. Filters results by Bank Name.

Values are dynamic. Call GET /v1/datasets/refs/region_banks_all to retrieve the current data dictionary, and use the returned entry's key as this parameter's value.

simple_namestring

Abbreviation Of Deposit Bank. Filters results by Abbreviation Of Deposit Bank.

bank_operation_idstring

Deposit Method. Filters results by Deposit Method.

Values are dynamic. Call GET /v1/datasets/refs/deposit_channel_types to retrieve the current data dictionary, and use the returned entry's key as this parameter's value.

languagestring

Language. Filters results by Language.

Allowed values:

en - English
zh-CN - Simplified Chinese
zh-HK - Traditional Chinese

enzh-CNzh-HK

org_idstring

Broker. Filters results by Broker.

Values are dynamic. Call GET /v1/datasets/refs/member_organizations to retrieve the current data dictionary, and use the returned entry's key as this parameter's value.

audit_statusstring

Approval Status. Filters results by Approval Status.

Allowed values:

new_pending_review - New to approve
delete_pending_review - Delete to approve
update_pending_review - Edit to approve
on_pending_review - List to approve
off_pending_review - Delist to approve
init - Initial

new_pending_reviewdelete_pending_reviewupdate_pending_reviewon_pending_reviewoff_pending_reviewinit

statestring

Publish Status. Filters results by Publish Status.

Allowed values:

1 - Active
2 - Inactive
99 - New

1299

currencystring

Currency. Filters results by Currency.

Values are dynamic. Call GET /v1/datasets/refs/tenant_deposit_currencies to retrieve the current data dictionary, and use the returned entry's key as this parameter's value.

pageinteger

Page. Page number to retrieve, starting from 1.

page_sizeinteger

Page Size. Number of records to return per page.

orderByarray<object>

Order By. Array of sorting rules. Each item defines a sort field and direction.

Responses

HTTP 200On success, returns paginated Deposit Parameter Setups records together with pagination metadata such as the page number, page size, and total record count.

Standard response envelopecodemessagedata

dataobjectdata structure

listarray<object>required

List. Returned value: List of list.

Child attributes

statestring

Publish Status. Returned value: Publish Status.

state_valstring

Publish Status (raw value). Raw value of state. The state field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

region_idstring

Bank Region. Returned value: Bank Region.

region_id_valstring

Bank Region (raw value). Raw value of region_id. The region_id field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

region_bank_idsstring

Bank Name. Returned value: Bank Name.

region_bank_ids_valstring

Bank Name (raw value). Raw value of region_bank_ids. The region_bank_ids field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

custom_bank_operation_typesstring

Deposit Method(Weight). Returned value: Deposit Method(Weight).

fps_account_nostring

FPS Account ID. Returned value: FPS Account ID.

currenciesstring

Currency. Returned value: Currency.

lb_bank_account_idstring

Beneficiary Bank Abbr.(Account Type). Returned value: Beneficiary Bank Abbr.(Account Type).

lb_bank_account_id_valstring

Beneficiary Bank Abbr.(Account Type) (raw value). Raw value of lb_bank_account_id. The lb_bank_account_id field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

audit_statusstring

Approval Status. Returned value: Approval Status.

audit_status_valstring

Approval Status (raw value). Raw value of audit_status. The audit_status field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

auth_statestring

Verification Status. Returned value: Verification Status.

auth_state_valstring

Verification Status (raw value). Raw value of auth_state. The auth_state field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

prioritystring

Priority. Returned value: Priority.

edda_auth_typestring

eDDA Auth Type. Returned value: eDDA Auth Type.

edda_auth_type_valstring

eDDA Auth Type (raw value). Raw value of edda_auth_type. The edda_auth_type field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

fee_payerstring

Cost Born By. Returned value: Cost Born By.

fee_payer_valstring

Cost Born By (raw value). Raw value of fee_payer. The fee_payer field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

language_guides_jsonstring

Language Guides. Returned value: Language Guides.

org_idstring

Broker. Returned value: Broker.

org_id_valstring

Broker (raw value). Raw value of org_id. The org_id field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

created_atstring

Create Time. Returned value: Create Time. The date or time format follows the value returned by the API.

updated_atstring

Update Time. Returned value: Update Time. The date or time format follows the value returned by the API.

totalintegerrequired

Total. Returned value: Total number of matching records, used for pagination.

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

Request

curl --get \
  --url 'https://b-api.longbridge.xyz/v1/datasets/atm_group_deposit_configs' \
  --header 'Authorization: Bearer <token>' \
  --data-urlencode 'filters={}' \
  --data-urlencode 'page=1' \
  --data-urlencode 'page_size=20' \
  --data-urlencode 'orderBy=[]'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "state": "Active",
        "state_val": "1",
        "region_id": "Banks in Hong Kong",
        "region_id_val": "1",
        "region_bank_ids": "AutoTest",
        "region_bank_ids_val": "32292",
        "custom_bank_operation_types": "eDDA(1)",
        "fps_account_no": "",
        "currencies": "HKD",
        "lb_bank_account_id": "示例用户",
        "lb_bank_account_id_val": "示例用户",
        "audit_status": "",
        "audit_status_val": "",
        "auth_state": "Not Enabled",
        "auth_state_val": "0",
        "priority": "2",
        "edda_auth_type": "Authorize in APP（sDDA）",
        "edda_auth_type_val": "1",
        "fee_payer": "共同 SHA",
        "fee_payer_val": "共同 SHA",
        "language_guides_json": "{\"en\":\"招行香港一卡通入金指引-线上配置勿删\",\"zh-CN\":\"招行香港一卡通入金指引-线上配置勿删\",\"zh-HK\":\"招行香港一卡通入金指引-线上配置勿删\"}",
        "org_id": "Standard A/C1",
        "org_id_val": "1",
        "created_at": "1784055443",
        "updated_at": "1784055443"
      }
    ],
    "total": 1008
  }
}