接口说明
调用方:商户接入系统
接收方:银账通系统
功能:商户余额查询
请求地址及接口名
生产环境:https://fzxt-yzt-openapi.wangcaio2o.com
测试环境:https://fzxt-yzt-openapi.imageco.cn
接口名(method):merchant.balanceQuery
公共请求参数
名称 | 类型 | 必须 | 描述 | 示例值 |
---|---|---|---|---|
app_id | string(32) | 是 | 接入方appId | 20210911888888888888888888 |
method | string(32) | 是 | 接口名 | bkfunds.split.apply |
format | string(16) | 是 | 报文格式,仅支持JSON | json |
charset | string(16) | 是 | 字符编码 | UTF-8 |
sign_type | string(8) | 是 | 签名算法类型,仅支持RSA2 | RSA2 |
timestamp | string(16) | 是 | 时间戳,格式为yyyy-MM-dd HH:mm:ss,时区为GMT+8。服务端允许客户端请求最大时间误差为10分钟 | 2021-09-11 12:00:00 |
version | string(8) | 是 | 版本号 | 1.0 |
app_auth_token | string(128) | 否 | token | 01c9a4191bfd4609d26 |
sign | string(256) | 是 | 请求参数的签名串 | XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
biz_content | string | 是 | 业务请求参数,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档 | {“file”:””,”type”:”1”} |
业务请求参数
名称 | 类型 | 必须 | 描述 | 示例值 |
---|---|---|---|---|
account_sub_type | string | 是 | 账户类型 0-收款账户 1-付款账户 | 0 |
merchant_id | integer | 是 | 翼码商户id | 1000000000926 |
sso_node_id | string | 是 | 机构id | 00061783 |
store_no | string | 否 | 自定义门店号 |
范例:
{
"account_sub_type":"0",
"merchant_id":1000000000926,
"sso_node_id":"00061783",
"store_no":""
}
请求示例
"biz_content": "{
"account_sub_type":"0",
"merchant_id":1000000000926,
"sso_node_id":"00061783",
"store_no":""
}",
"method": "merchant.balanceQuery",
"format": "json",
"sign": "BCl03jc6RBgKyBuc+Tvh0KG1Jeq8ueYZqY+OCOcO4KnldEpI5Snc/rnGO+p2GUCEbczuU8VQBNzteXOU4HnoFdy4Me5XrzO/UJeIDJRaW+LeLKOM7JSZ8Z1VSscF4Jr/L4+IN9lv3stv+qhoDU4DKmOx/PrqfQ2lO6NaStda33Cu4NTda83VlsE/hD2mOSvDO1u75Hg2tHQpe8MSzwOj7lzTU2xijlm1gQt+OA/b+91sA1d1GvEfTG4qqQlVFEkr4FqS1b/qkC+Ex1M1XtaChGgL/BeINVvjdh4lTn5K/ZLbZE5FuXkRPE6zZqcq7kGbN2B3iBiz1v7UsTLkP0ZaBA==",
"app_id": "20211012897445821048422400",
"sign_type": "RSA2",
"version": "1.0",
"timestamp": "2024-04-2815:09:29"
}
名称 | 类型 | 必须 | 描述 | 示例值 |
---|---|---|---|---|
request_id | string | 是 | 每次请求唯一id | 4e770f101c9a4191bfd4609d26c6e0bd |
code | integer | 是 | 返回码 | 10000 |
sign | string | 是 | 响应参数的签名串 | XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
业务响应参数
名称 | 类型 | 必须 | 描述 | 示例值 |
---|---|---|---|---|
data | JSONObject | 否 | 业务数据 | |
success | boolean | 否 | 是否成功 | true |
data 业务数据 (JSONObject)
名称 | 类型 | 必须 | 描述 | 示例值 |
---|---|---|---|---|
available_balance | long | 否 | 可提现金额 | 0 |
frozen_balance | long | 否 | 冻结金额 | 0 |
amount_retained | long | 否 | 预留金额 | 0 |
total_balance | long | 否 | 总余额 | 0 |
响应示例
{
"merchant_balanceQuery_response": {
"request_id": "openapi_19f59a98bf8949b0ab1dbb47298a0ac7",
"code": 10000,
"data": {
"available_balance": 0,
"frozen_balance": 0,
"amount_retained": 0
},
"success": true
},
"sign": "XbTvgvjfkcSledNlcuPZ1wuf/o/GDyThZL/JuXck/swFwbNh33SwNqBgjW0JdKMk0irWc1LyRr+osuCU8SoXkUamjEmuO/EtGOvNRjjFTwhECTImHIS/e4O96DDToQrvA6lCZPo7AIP6lkWmS/bd3l+UkxKBPfvdSUldrdCKo2lMTQtsUEHOCwVyE4ghLPoPQIjMAO3jFoOjgXyN02x8Sm8vh1/O2chFyxZPyWS891BjeVs4fafbHC84XBgN3oIYSmkVmlP3Xt6RIYSTbO1/ssiZY1E9oStCATdpPosIoEYdVDayhl3r0SbDf2AQqGMsTIq4Xezjjw8iVx3DwJFY3w=="
}