寰宇支付

主题

获取省市区数据 ​

获取中国大陆省市区三级联动数据，用于汇付天下等支付渠道的地址信息填写。

接口列表 ​

接口方法说明参数
/addons/paychannel/channel/hui_fu/regionDataGET获取完整省市区数据无
/addons/paychannel/channel/hui_fu/provinceListGET获取省份列表无
/addons/paychannel/channel/hui_fu/cityListGET获取指定省份的城市列表province（省份名称）
/addons/paychannel/channel/hui_fu/districtListGET获取指定城市的区县列表province、city（城市名称）

1. 获取完整省市区数据 ​

GET  /addons/paychannel/channel/hui_fu/regionData

返回完整的三级联动省市区数据，数据量较大，建议仅在需要完整数据时调用。

响应示例 ​

json
{
    "code": 1,
    "msg": "获取成功",
    "data": {
        "北京": {
            "val": "110000",
            "items": {
                "北京市": {
                    "val": "110100",
                    "items": {
                        "东城区": "110101",
                        "西城区": "110102",
                        "朝阳区": "110105"
                    }
                }
            }
        }
    }
}

2. 获取省份列表 ​

GET  /addons/paychannel/channel/hui_fu/provinceList

响应参数 ​

参数名类型说明
namestring省份名称
codestring省份编码

响应示例 ​

json
{
    "code": 1,
    "msg": "获取成功",
    "data": [
        {"name": "北京", "code": "110000"},
        {"name": "河北省", "code": "130000"}
    ]
}

3. 获取城市列表 ​

GET  /addons/paychannel/channel/hui_fu/cityList?province=河北省

请求参数 ​

参数名类型必填说明
provincestring是省份名称

响应参数 ​

参数名类型说明
namestring城市名称
codestring城市编码

4. 获取区县列表 ​

GET  /addons/paychannel/channel/hui_fu/districtList?province=河北省&city=石家庄市

请求参数 ​

参数名类型必填说明
provincestring是省份名称
citystring是城市名称

响应参数 ​

参数名类型说明
namestring区县名称
codestring区县编码（6 位行政区划代码）

响应示例 ​

json
{
    "code": 1,
    "msg": "获取成功",
    "data": [
        {"name": "长安区", "code": "130102"},
        {"name": "桥西区", "code": "130104"},
        {"name": "新华区", "code": "130105"}
    ]
}

使用建议

  • 前端三级联动选择器建议依次调用：provinceList → cityList → districtList
  • 如需完整数据用于本地缓存，可调用 regionData 一次性获取
  • 省份和城市名称需完全匹配，注意直辖市（如"北京市"）的层级结构