Deposit Guidelines Setups

Queries Deposit Guidelines 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.

POSThttps://b-api.lbkrs.com/v1/datasets/atm_deposit_guide_configs

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_depositguide.depositguide_query

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

Request body application/json

filtersobject

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

Child attributes

guide_typestring

Guideline Type. Filters results by Guideline Type.

Values

1: General Guidelines
2: Specific Bank

idstring

Deposit Guideline ID. Filters results by Deposit Guideline ID.

namestring

Name Of Deposit Guideline. Filters results by Name Of Deposit Guideline.

languagestring

Language. Filters results by Language.

Values

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

org_idstring

Org ID. Filters results by Org ID.

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.

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 Guidelines 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

idstring

Deposit Guideline ID. Returned value: Unique identifier of the current record.

updated_atstring

Updated At. Returned value: Updated At. The date or time format follows the value returned by the API.

currenciesstring

Currency. Returned value: Currency.

guide_typestring

Guide Type. Returned value: Guide Type.

guide_type_valstring

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

namestring

Name Of Deposit Guideline. Returned value: Name Of Deposit Guideline.

languagestring

Language. Returned value: Language.

language_valstring

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

bank_operation_idstring

Deposit Method. Returned value: Deposit Method.

bank_operation_id_valstring

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

org_idstring

Org ID. Returned value: Org ID.

org_id_valstring

Org ID (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.

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 --request POST \
  --url 'https://b-api.lbkrs.com/v1/datasets/atm_deposit_guide_configs' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "filters": {},
  "page": 1,
  "page_size": 20,
  "orderBy": []
}'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "36",
        "updated_at": "1753176480",
        "currencies": "USD/HKD",
        "guide_type": "General Guidelines",
        "guide_type_val": "1",
        "name": "招行香港一卡通入金指引-线上配置勿删",
        "language": "Simplified Chinese",
        "language_val": "zh-CN",
        "bank_operation_id": "Online Banking Transfer",
        "bank_operation_id_val": "3",
        "org_id": "Standard A/C1",
        "org_id_val": "1"
      }
    ],
    "total": 933
  }
}