接口说明

调用方:商户接入系统

接收方:银账通系统

功能:商户余额查询

请求地址及接口名

生产环境:https://fzxt-yzt-openapi.wangcaio2o.com

测试环境:https://fzxt-yzt-openapi.imageco.cn

接口名(method):merchant.balanceQuery

公共请求参数

名称类型必须描述示例值
app_idstring(32)接入方appId20210911888888888888888888
methodstring(32)接口名bkfunds.split.apply
formatstring(16)报文格式,仅支持JSONjson
charsetstring(16)字符编码UTF-8
sign_typestring(8)签名算法类型,仅支持RSA2RSA2
timestampstring(16)时间戳,格式为yyyy-MM-dd HH:mm:ss,时区为GMT+8。服务端允许客户端请求最大时间误差为10分钟2021-09-11 12:00:00
versionstring(8)版本号1.0
app_auth_tokenstring(128)token01c9a4191bfd4609d26
signstring(256)请求参数的签名串XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
biz_contentstring业务请求参数,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档{“file”:””,”type”:”1”}

业务请求参数

名称类型必须描述示例值
account_sub_typestring账户类型 0-收款账户 1-付款账户0
merchant_idinteger翼码商户id1000000000926
sso_node_idstring机构id00061783
store_nostring自定义门店号

范例:

  1. {
  2. "account_sub_type":"0",
  3. "merchant_id":1000000000926,
  4. "sso_node_id":"00061783",
  5. "store_no":""
  6. }

请求示例

  1. "biz_content": "{
  2. "account_sub_type":"0",
  3. "merchant_id":1000000000926,
  4. "sso_node_id":"00061783",
  5. "store_no":""
  6. }",
  7. "method": "merchant.balanceQuery",
  8. "format": "json",
  9. "sign": "BCl03jc6RBgKyBuc+Tvh0KG1Jeq8ueYZqY+OCOcO4KnldEpI5Snc/rnGO+p2GUCEbczuU8VQBNzteXOU4HnoFdy4Me5XrzO/UJeIDJRaW+LeLKOM7JSZ8Z1VSscF4Jr/L4+IN9lv3stv+qhoDU4DKmOx/PrqfQ2lO6NaStda33Cu4NTda83VlsE/hD2mOSvDO1u75Hg2tHQpe8MSzwOj7lzTU2xijlm1gQt+OA/b+91sA1d1GvEfTG4qqQlVFEkr4FqS1b/qkC+Ex1M1XtaChGgL/BeINVvjdh4lTn5K/ZLbZE5FuXkRPE6zZqcq7kGbN2B3iBiz1v7UsTLkP0ZaBA==",
  10. "app_id": "20211012897445821048422400",
  11. "sign_type": "RSA2",
  12. "version": "1.0",
  13. "timestamp": "2024-04-2815:09:29"
  14. }
名称类型必须描述示例值
request_idstring每次请求唯一id4e770f101c9a4191bfd4609d26c6e0bd
codeinteger返回码10000
signstring响应参数的签名串XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

业务响应参数

名称类型必须描述示例值
dataJSONObject业务数据
successboolean是否成功true

data 业务数据 (JSONObject)

名称类型必须描述示例值
available_balancelong可提现金额0
frozen_balancelong冻结金额0
amount_retainedlong预留金额0
total_balancelong总余额0

响应示例

  1. {
  2. "merchant_balanceQuery_response": {
  3. "request_id": "openapi_19f59a98bf8949b0ab1dbb47298a0ac7",
  4. "code": 10000,
  5. "data": {
  6. "available_balance": 0,
  7. "frozen_balance": 0,
  8. "amount_retained": 0
  9. },
  10. "success": true
  11. },
  12. "sign": "XbTvgvjfkcSledNlcuPZ1wuf/o/GDyThZL/JuXck/swFwbNh33SwNqBgjW0JdKMk0irWc1LyRr+osuCU8SoXkUamjEmuO/EtGOvNRjjFTwhECTImHIS/e4O96DDToQrvA6lCZPo7AIP6lkWmS/bd3l+UkxKBPfvdSUldrdCKo2lMTQtsUEHOCwVyE4ghLPoPQIjMAO3jFoOjgXyN02x8Sm8vh1/O2chFyxZPyWS891BjeVs4fafbHC84XBgN3oIYSmkVmlP3Xt6RIYSTbO1/ssiZY1E9oStCATdpPosIoEYdVDayhl3r0SbDf2AQqGMsTIq4Xezjjw8iVx3DwJFY3w=="
  13. }