Supported Bank Setups

Queries Supported Bank 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_region_banks

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_regionbanks.regionbanks_querycmbc.hk_deposit_detailRequired

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

idstring

Supported Bank ID. Filters results by Supported Bank ID.

regionstring

Bank Region. Filters results by Bank Region.

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

namestring

Bank Name Chinese. Filters results by Bank Name Chinese.

bank_codestring

Bank Code. Filters results by Bank Code.

swift_codestring

Swift Code. Filters results by Swift Code.

updated_atobject

Update Time. Filters results by Update Time.

Child attributes

gtestring

Greater Than or Equal. Inclusive lower bound of the filter range.

ltestring

Less Than or Equal. Inclusive upper bound of the filter range.

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 Supported Bank 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

Supported Bank ID. Returned value: Unique identifier of the current record.

regionstring

Bank Region. Returned value: Bank Region.

region_valstring

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

is_allow_bind_cardstring

Whether Card Binding Is Allowed. Returned value: Indicates whether whether card binding is allowed.

is_allow_bind_card_valstring

Whether Card Binding Is Allowed (raw value). Raw value of is_allow_bind_card. The is_allow_bind_card field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

multi_namestring

Bank Name. Returned value: Bank Name.

bank_codestring

Bank Code. Returned value: Bank Code.

swift_codestring

Swift Code. Returned value: Swift Code.

addressstring

Address. Returned value: Address.

right_backgroundstring

Bank Card Background Color (right). Returned value: Bank Card Background Color (right).

left_backgroundstring

Bank Card Background Color (left). Returned value: Bank Card Background Color (left).

iconstring

Icon. Returned value: Icon.

logostring

Bank Logo. Returned value: Bank Logo.

account_lengthstring

Bank Card Length. Returned value: Bank Card Length.

bank_group_idstring

Name Of Head Office. Returned value: Name Of Head Office.

bank_group_id_valstring

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

deposit_witness_statestring

Deposit Attestation. Returned value: Deposit Attestation.

deposit_witness_state_valstring

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

created_atstring

Created Time. Returned value: Created 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.

prioritystring

Priority. Returned value: Priority.

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_region_banks' \
  --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": [
      {
        "id": "32292",
        "region": "Banks in Hong Kong",
        "region_val": "HONGKONG",
        "is_allow_bind_card": "Allowed",
        "is_allow_bind_card_val": "1",
        "multi_name": "{\"en\":\"AutoTest\",\"zh-CN\":\"AutoTest\",\"zh-HK\":\"AutoTest\"}",
        "bank_code": "",
        "swift_code": "AutoTest",
        "address": "",
        "right_background": "#FF775E",
        "left_background": "#2E9AFE",
        "icon": "https://pub-canary.lbkrs.com/cms/2023/0/c7sPyexHf6q4wsNbbPmELtSGYoGkTtve/tb_round_AU3x.png",
        "logo": "https://pub-canary.lbkrs.com/cms/2023/0/3scGUNrGFFFEFg4R6Vq8aHuVc18GHuR6/tb_round_AU3x.png",
        "account_length": "0",
        "bank_group_id": " ",
        "bank_group_id_val": "0",
        "deposit_witness_state": "Attestation Available",
        "deposit_witness_state_val": "yes",
        "created_at": "1784055436",
        "updated_at": "1784055436",
        "priority": "595"
      }
    ],
    "total": 105
  }
}