com.github.binarywang.wxpay.service

接口 BankService

所有已知实现类:

BankServiceImpl

public interface BankService

 微信支付-银行组件
 

作者:

zhongjun

方法概要

限定符和类型	方法和说明
CitiesResult	areasCities(Integer provinceCode) 查询城市列表API 通过本接口根据省份编码获取省份下的城市列表信息，不包含中国港澳台地区城市信息，可用于支行数据过滤查询 请求方式：GET（HTTPS） 请求地址：https://api.mch.weixin.qq.com/v3/capital/capitallhh/areas/provinces/{province_code}/cities 文档地址：https://pay.weixin.qq.com/wiki/doc/apiv3_partner/Offline/apis/chapter11_2_5.shtml
ProvincesResult	areasProvinces() 查询省份列表API 通过本接口获取省份列表数据（不包含中国港澳台地区），可用于省份下的城市数据查询 请求方式：GET（HTTPS） 请求地址：https://api.mch.weixin.qq.com/v3/capital/capitallhh/areas/provinces 文档地址：https://pay.weixin.qq.com/wiki/doc/apiv3_partner/Offline/apis/chapter11_2_4.shtml
BankBranchesResult	bankBranches(String bankAliasCode, Integer cityCode, Integer offset, Integer limit) 查询支行列表API 本接口可以用于根据银行别名编码（仅支持需要填写支行的银行别名编码）和城市编码过滤查询支行列表数据 请求方式：GET（HTTPS） 请求地址：https://api.mch.weixin.qq.com/v3/capital/capitallhh/banks/{bank_alias_code}/branches 文档地址：https://pay.weixin.qq.com/wiki/doc/apiv3_partner/Offline/apis/chapter11_2_5.shtml
BankingResult	corporateBanking(Integer offset, Integer limit) 支持对公业务的银行列表 请求方式：GET（HTTPS） 请求地址：https://api.mch.weixin.qq.com/v3/capital/capitallhh/banks/corporate-banking 文档地址：https://pay.weixin.qq.com/wiki/doc/apiv3_partner/Offline/apis/chapter11_2_3.shtml
BankingResult	personalBanking(Integer offset, Integer limit) 查询支持个人业务的银行列表 请求方式：GET（HTTPS） 请求地址：https://api.mch.weixin.qq.com/v3/capital/capitallhh/banks/personal-banking 文档地址：https://pay.weixin.qq.com/wiki/doc/apiv3_partner/Offline/apis/chapter11_2_2.shtml
BankAccountResult	searchBanksByBankAccount(String accountNumber) 获取对私银行卡号开户银行 请求方式：GET（HTTPS） 请求地址：https://api.mch.weixin.qq.com/v3/capital/capitallhh/banks/search-banks-by-bank-account 文档地址：https://pay.weixin.qq.com/wiki/doc/apiv3_partner/Offline/apis/chapter11_2_1.shtml

方法详细资料

searchBanksByBankAccount

BankAccountResult searchBanksByBankAccount(String accountNumber)
                                    throws WxPayException

 获取对私银行卡号开户银行

 请求方式：GET（HTTPS）
 请求地址：https://api.mch.weixin.qq.com/v3/capital/capitallhh/banks/search-banks-by-bank-account

 文档地址：https://pay.weixin.qq.com/wiki/doc/apiv3_partner/Offline/apis/chapter11_2_1.shtml
 

参数:

accountNumber - 银行卡号 该字段需进行加密处理，加密方法详见敏感信息加密说明。(提醒：必须在HTTP头中上送Wechatpay-Serial)

返回:

BankAccountResult 对私银行卡号开户银行信息

抛出:

WxPayException - .

personalBanking

BankingResult personalBanking(Integer offset,
                              Integer limit)
                       throws WxPayException

 查询支持个人业务的银行列表

 请求方式：GET（HTTPS）
 请求地址：https://api.mch.weixin.qq.com/v3/capital/capitallhh/banks/personal-banking

 文档地址：https://pay.weixin.qq.com/wiki/doc/apiv3_partner/Offline/apis/chapter11_2_2.shtml
 

参数:

offset - 本次查询偏移量

limit - 本次请求最大查询条数,最大值为200

返回:

PersonalBankingResult 支持个人业务的银行列表信息

抛出:

WxPayException - .

corporateBanking

BankingResult corporateBanking(Integer offset,
                               Integer limit)
                        throws WxPayException

 支持对公业务的银行列表

 请求方式：GET（HTTPS）
 请求地址：https://api.mch.weixin.qq.com/v3/capital/capitallhh/banks/corporate-banking

 文档地址：https://pay.weixin.qq.com/wiki/doc/apiv3_partner/Offline/apis/chapter11_2_3.shtml
 

参数:

offset - 本次查询偏移量

limit - 本次请求最大查询条数,最大值为200

返回:

BankingResult 支持对公业务的银行列表信息

抛出:

WxPayException - .

areasProvinces

ProvincesResult areasProvinces()
                        throws WxPayException

 查询省份列表API
 通过本接口获取省份列表数据（不包含中国港澳台地区），可用于省份下的城市数据查询

 请求方式：GET（HTTPS）
 请求地址：https://api.mch.weixin.qq.com/v3/capital/capitallhh/areas/provinces

 文档地址：https://pay.weixin.qq.com/wiki/doc/apiv3_partner/Offline/apis/chapter11_2_4.shtml
 

返回:

ProvincesResult 省份列表信息

抛出:

WxPayException - .

areasCities

CitiesResult areasCities(Integer provinceCode)
                  throws WxPayException

 查询城市列表API
 通过本接口根据省份编码获取省份下的城市列表信息，不包含中国港澳台地区城市信息，可用于支行数据过滤查询

 请求方式：GET（HTTPS）
 请求地址：https://api.mch.weixin.qq.com/v3/capital/capitallhh/areas/provinces/{province_code}/cities

 文档地址：https://pay.weixin.qq.com/wiki/doc/apiv3_partner/Offline/apis/chapter11_2_5.shtml
 

返回:

CitiesResult 城市列表信息

抛出:

WxPayException - .

bankBranches

BankBranchesResult bankBranches(String bankAliasCode,
                                Integer cityCode,
                                Integer offset,
                                Integer limit)
                         throws WxPayException

 查询支行列表API
 本接口可以用于根据银行别名编码（仅支持需要填写支行的银行别名编码）和城市编码过滤查询支行列表数据

 请求方式：GET（HTTPS）
 请求地址：https://api.mch.weixin.qq.com/v3/capital/capitallhh/banks/{bank_alias_code}/branches

 文档地址：https://pay.weixin.qq.com/wiki/doc/apiv3_partner/Offline/apis/chapter11_2_5.shtml
 

参数:

bankAliasCode - 银行别名的编码，查询支行接口仅支持需要填写支行的银行别名编码。示例值：1000006247

cityCode - 城市编码，唯一标识一座城市，用于结合银行别名编码查询支行列表。示例值：536

offset - 非负整数，表示该次请求资源的起始位置，从0开始计数。调用方选填，默认为0。offset为20，limit为100时，查询第21-120条数据

limit - 非0非负的整数，该次请求可返回的最大资源条数。示例值：200

返回:

BankBranchesResult 城市列表信息

抛出:

WxPayException - .