Region Bank - WhaleAPI（Public）

Region Bank

Request

Query Params

currency

string

required

Currency（Currency. If not provided, it will default to HKD. This parameter is mainly used for obtaining corresponding tags for banking, securities, eDDA, and FPS payments for a particular currency. In Hong Kong, bank lists are sorted by tag count and tag priority. The currency only affects the sorting of the bank list in the Hong Kong region）

account_no

string

required

Account No

Responses

🟢200OK

*/*

success

Body

code

number

required

message

string

required

data

object

required

list

array [object {11}]

required

Bank List

mainland_card_flag

string

required

Whether the mainland bank card is bound

Example

{
  "code": 0,
  "message": "string",
  "data": {
    "list": [
      {
        "value": [
          {
            "id": 0,
            "name": "string",
            "name_en": "string",
            "swift_code": "string",
            "icon": "string",
            "logo": "string",
            "left_background": "string",
            "right_background": "string",
            "bank_code": "string",
            "support_witness": "string",
            "account_length": "string",
            "auth_flows": [
              {
                "HKD": {
                  "Ids": [
                    "string"
                  ]
                },
                "USD": {}
              }
            ]
          }
        ],
        "region": "string",
        "region_name": "string",
        "bankcode_state": 0,
        "need_address": 0,
        "required_address": 0,
        "need_swift": 0,
        "need_account_type": 0,
        "icon": "string",
        "tip": "string",
        "tags": "string"
      }
    ],
    "mainland_card_flag": "string"
  }
}