商户余额查询

更新时间 2024-07-24 02:58:49

我的收藏

查询商户各渠道账户余额。

使用限制

无

接口说明

服务商发起提现请求，SALT 可以在第三方平台-设置-开发设置获取，详见服务商接入准备。

开发者发起的提现请求，SALT 可以在开发者后台的支付设置中获取(路径：小程序开发者平台-功能管理-支付-支付产品-支付设置- SALT)，详见开发者接入准备。

基本信息

基本信息
HTTP URL	https://developer.toutiao.com/api/apps/ecpay/saas/query_merchant_balance
HTTP Method	POST
接口频次	40QPS(小程序app_id维度或thirdparty_id维度)

请求头

名称	类型	必填	描述
Content-Type	string	是	固定值 "application/json"

请求参数

名称	类型	是否必填	最大长度	描述	示例值
thirdparty_id	string	条件选填	64	小程序第三方平台应用 id。在服务商发起提现请求的条件下必填	ttc4a8b2155b82682f
app_id	string	条件选填	64	小程序的 app_id。在服务商为自己提现的情况下可不填，其他情况必填	ttdb96ad2b44aeff3301
merchant_uid	string	是	128	进件完成返回的商户号	M70372492301718182840
channel_type	string	是	32	提现渠道枚举值: •alipay: 担保支付普通版支付宝 •wx: 担保支付普通版微信 •hz: 担保支付普通版抖音支付 •yzt: 担保支付企业版聚合账户	alipay
merchant_entity	number	否	-	抖音信息和光合信号主体标识: •不传或传0或1 查抖音信息主体账户余额 •传2查光合信号主体账户余额（查询担保支付企业版聚合账户时，必传 2 ）	1 说明：channel_type为yzt时，指定为2
sign	string	是	344	签名，详见签名DEMO	cd67804fe6c25fd66a49975cc59ff81b

请求示例

服务商模式

json复制
{
  "thirdparty_id": "tta4bad2073b9009c7",
  "app_id": "",
  "merchant_uid": "M70775300146143419322",
  "channel_type": "alipay",
  "sign": "6ba1cce7bb9b157409f321b82e72fdd1f"
}

开发者模式

json复制
{
  "app_id": "tt55ed2350ca8b68ec01",
  "merchant_uid": "M70775300146143419322",
  "channel_type": "alipay",
  "sign": "6ba1cce7bb9b15f309f2cb82e72fdd1f"
}

响应参数

公共响应参数

名称	类型	是否必填	最大长度	描述	示例值
err_no	number	是	-	返回码，详见下文错误码	2008
err_tips	string	是	-	返回码描述,详见下文错误码	签名校验异常，请使用正确的签名和 json 传参

业务响应参数

名称	类型	是否必填	最大长度	描述	示例值
account_info	object	是	-	余额信息	"account_info": { "online_balance": 20, "withdrawable_balacne":20, "freeze_balance": 20 }
settle_info	object	是	-	结算信息	"settle_info": { "settle_type": 2, "settle_account":"bytedance@163.com", "bankcard_no": "", "bank_name": "" }
merchant_entity	number	是	-	抖音信息和光合信号标识： 1: 当前余额所属抖音信息 2: 当前余额所属光合信号	1

account_info 格式

名称	类型	是否必填	最大长度	描述	示例值
online_balance	number	是	[0, 2147483647]	在途余额；CNY、单位分	100
withdrawable_balacne	number	是	[0, 2147483647]	可提现余额；CNY、单位分	100
freeze_balance	number	是	[0, 2147483647]	冻结准备金余额；CNY、单位分	100

settle_info 格式

名称	类型	是否必填	最大长度	描述	示例值
settle_type	number	是	-	结算类型枚举值： 1: 银行卡结算 2: 支付宝结算	1
settle_account	string	是	64	支付宝结算时，支付宝账号	bytedance@163.com
bankcard_no	string	是	64	银行卡结算时，银行卡号	6214681130644967
bank_name	string	是	64	银行卡结算时，银行卡对应银行名称	北京银行股份有限公司东升科技园支行

响应示例

正常响应示例

json复制
{
  "err_no": 0,
  "err_tips": "",
  "account_info": {
    "online_balance": 20,
    "withdrawable_balacne": 100000,
    "freeze_balance": 200000
  },
  "settle_info": {
    "settle_type": 2,
    "settle_account": "bytedance@163.com",
    "bankcard_no": "",
    "bank_name": ""
  },
  "merchant_entity": 1
}

异常响应示例

json复制
{
  "err_no": 2008,
  "err_tips": "签名校验异常，请使用正确的签名和 json 传参"
}

错误码

错误码err_no	描述err_tips	排查建议
0	""	受理成功
1000	内部错误，请稍后重试	稍后重试
1005	频率控制，请稍后重试	稍后重试
1091	功能暂未开启	功能未开启
2008	签名校验异常，请使用正确的签名和 json 传参	请检查参数，详见签名DEMO
2010	业务参数处理异常	检查请求参数，修改后重试
2042	小程序appid无效，请检查app_id字段	检查app_id字段信息是否有误
2047	服务商id无效，请检查thirdparty_id字段	检查thirdparty_id字段信息是否有误
2048	未查询到服务商与小程序的授权关系	检查服务商与小程序的授权关系
7007	账户不存在	请检查传入的商户号（merchant_uid）是否有误
8002	账户状态异常	请检查传入的商户号（merchant_uid）在对应渠道（channel_type）是否进件成功
8005	渠道结算信息不存在	请检查传入的商户号（merchant_uid），提现渠道(channel_type), 主体标识(merchant_entity)对应的结算信息是否有误