Supported Bank Setups

POSThttps://b-api.longbridge.xyz/v1/datasets/atm_region_banks

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

filtersobject

Filters

Child attributes

filters.idstring

Supported Bank ID

filters.regionstring

Bank Region. Values are dynamically queried from atm_regions (not fixed); fetch them live via GET /v1/datasets/refs/regions.

filters.namestring

Bank Name Chinese

filters.bank_codestring

Bank Code

filters.swift_codestring

Swift Code

filters.updated_atobject

Update Time. Range filter; both bounds are optional (omit a bound to leave that side unbounded).

Child attributes

filters.updated_at.gtestring

Greater Than or Equal

filters.updated_at.ltestring

Less Than or Equal

pageinteger

Page

page_sizeinteger

Page Size

orderByarray<object>

Order By

Responses

HTTP 200Paginated list result.

Standard response envelopecodemessagedata

dataobjectdata structure

listarray<object>required

List

totalintegerrequired

Total

Request

curl --request POST \
  --url 'https://b-api.longbridge.xyz/v1/datasets/atm_region_banks' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "filters": {},
  "page": 1,
  "page_size": 20,
  "orderBy": []
}'

Response

{
  "code": 0,
  "message": null,
  "data": {
    "list": [
      {
        "id": "<string>",
        "region": "<string>",
        "is_allow_bind_card": "<string>",
        "multi_name": "<string>",
        "bank_code": "<string>",
        "swift_code": "<string>",
        "address": "<string>",
        "right_background": "<string>",
        "left_background": "<string>",
        "icon": "<string>",
        "logo": "<string>",
        "account_length": "<string>",
        "bank_group_id": "<string>",
        "deposit_witness_state": "<string>",
        "created_at": "<string>",
        "updated_at": "<string>",
        "priority": "<string>"
      }
    ],
    "total": 0
  }
}