1. 资金接口
1.1. 查询余额
- URL：
/merchant/withdraw/querycash - Method：
POST
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| inst_no | String | 15 | Y | 机构编号，平台分配 |
| version | String | 11 | Y | 版本号，固定"200" |
| trace_no | String | 32 | Y | 请求流水号 |
| merchant_no | String | 15 | Y | 商户号 |
| key_sign | String | 32 | Y | 签名检验串,拼装所有传递参数加令牌（令牌名称为key），32位md5加密转换 |
以上为请求参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| return_code | String | 2 | Y | 响应码：“01”成功 ，02”失败，请求成功不代表业务处理成功 |
| return_msg | String | 128 | Y | 返回信息提示，“机构号不存在”“请求受限”等 |
| trace_no | String | 32 | Y | 请求流水号 |
| result_code | String | 2 | N | 业务结果：“01”成功 ，02”失败 |
| merchant_no | String | 15 | N | 商户号 |
| not_settle_amt | String | 11 | N | 清分金额（今日实时交易金额），单位分 |
| settling_amt | String | 11 | N | 清算金额（若商户为手动清算则为可手动提现金额；若商户为自动清算则为等待划款的金额），单位分 |
| settled_amt | String | 11 | N | 结算金额（商户要到账的金额），单位分 |
| book_balance | String | 11 | N | 账面总额（清分金额，清算金额，结算金额三者之和），单位分 |
| key_sign | String | 32 | N | 签名检验串,传参字典序加令牌（令牌名称为key），32位md5加密转换 |
以上为响应参数
- 根据《中国银联银行卡联网联合技术规范V2.1》定义：
- 清分
Clearing：对交易数据依据机构和交易类型进行分类汇总，并计算结算金额的过程。 - 清算
Settlement：指根据清分结果对交易数据进行净额轧差和提交并完成资金划拨的全过程。 - 结算
Settlement of Accounts：指完成客户账户间资金划拨的全过程。
- 清分
- 通俗地讲：
- 清分=记账，今日实时交易金额（每日00:00至23::59动态变化）
- 清算=算账，昨日交易总额（每日00:00开始清算昨天的）
- 结算=转账，商户要到账的金额（每日08:30开始结算）
举例如下：
book_balance（账面总额） = not_settle_amt（清分金额） + settling_amt（清算金额） + settled_amt（结算金额）
| 时间点 | book_balance（账面总额） | not_settle_amt（清分金额） | settling_amt（清算金额） | settled_amt（结算金额） |
|---|---|---|---|---|
| 2017-06-29 23:50:00 | 2400 | 2400 | 0 | 0 |
| 2017-06-30 00:10:00 | 2500 | 100 | 2400 | 0 |
| 2017-06-30 08:40:00 | 3200 | 800 | 0 | 2400 |
| 2017-06-30 08:50:00 | 3300 | 900 | 0 | 2400 |
| 2017-06-30 09:10:00 | 1000 | 1000 | 0 | 0 |
1.2. 查询提现手续费
- URL：
/merchant/withdraw/queryfee - Method：
POST - 备注：D0提现时候才调用，普通提现的未计算资金部分提现或者钱包提现即时到账时查询手续费
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| inst_no | String | 15 | Y | 机构编号，平台分配 |
| version | String | 11 | Y | 版本号，固定"200" |
| trace_no | String | 32 | Y | 请求流水号 |
| merchant_no | String | 15 | Y | 商户号 |
| amt | String | 11 | Y | 提现金额，单位分 |
| zero_arr_type | String | 2 | Y | D0类型：1普通纯D0 、2：钱包D0 |
| key_sign | String | 32 | Y | 签名检验串,传参字典序加令牌（令牌名称为key），32位md5加密转换 |
以上为请求参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| return_code | String | 2 | Y | 响应码：“01”成功 ，02”失败，请求成功不代表业务处理成功 |
| return_msg | String | 128 | Y | 返回信息提示，“查询成功”，“请求受限”等 |
| trace_no | String | 32 | Y | 请求流水号 |
| result_code | String | 2 | N | 业务结果：“01”成功 ，02”失败 |
| merchant_no | String | 15 | N | 商户号 |
| fee_amt | String | 11 | N | 手续费，单位分 |
| key_sign | String | 32 | N | 签名检验串,传参字段序加令牌（令牌名称为key），32位md5加密转换 |
以上为响应参数
1.3. 发起提现
- URL：
/merchant/withdraw/applycash - Method：
POST - 备注1：
- 提未结算资金【普通DO提现】：zero_arr_type="1"&cash_type="1"，fee_amt通过调用queryfee接口获取【查询提现手续费】；不限次数，可提现时间：9:00-22:00;
- 提已结算资金【普通手动提现】：zero_arr_type="1"&cash_type="2",免手续费，fee_amt固定传值零，不用调手续费查询接口；每天限一次；
- 备注2：
- 钱包模式下，提现选择钱包提现；资金池虽区分已结算和未结算，但是提现金额都可以提，可提现金额为总余额；
- 备注3：
- 钱包提现【即时到账】：zero_arr_type="2"&txn_type="4"，fee_amt通过调用queryfee接口获取【查询提现手续费】；不限次数，可提现时间：9:00-22:00;
- 钱包提现【次日到账】：zero_arr_type="2"&txn_type="3",免手续费，fee_amt固定传值零，不用调手续费查询接口；
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| inst_no | String | 15 | Y | 机构编号，平台分配 |
| version | String | 11 | Y | 版本号，固定"200" |
| trace_no | String | 32 | Y | 请求流水号 |
| merchant_no | String | 15 | Y | 商户号 |
| amt | String | 11 | Y | 提现金额，单位分 |
| fee_amt | String | 11 | Y | 手续费，单位分 |
| zero_arr_type | String | 2 | Y | 提现类型：1普通提现 、2：钱包提现 |
| cash_type | String | 2 | O | 资金类型（1:未结金额提现，2:已结金额提现）,zero_arr_type="1"时必填 |
| txn_type | String | 2 | O | 到账周期：3：次日到账 、4：实时到账,zero_arr_type="2"时必填 |
| key_sign | String | 32 | Y | 签名检验串,传参字典序加令牌（令牌名称为key），32位md5加密转换 |
以上为请求参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| return_code | String | 2 | Y | 响应码：“01”成功 ，02”失败，请求成功不代表业务处理成功 |
| return_msg | String | 128 | Y | 返回信息提示，“提现申请成功”，“请求受限”等 |
| trace_no | String | 32 | Y | 请求流水号 |
| result_code | String | 2 | N | 业务结果：“01”成功 ，02”失败 |
| merchant_no | String | 15 | N | 商户号 |
| key_sign | String | 32 | N | 签名检验串,传参字典序加令牌（令牌名称为key），32位md5加密转换 |
以上为响应参数
1.4. 查询清算
- URL：
/merchant/withdraw/settlementrecords - Method：
POST - 推荐单天查询，跨度大的日期清算查询，请注意延长响应时间，推荐60s
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| inst_no | String | 15 | Y | 机构编号，平台分配 |
| version | String | 11 | Y | 版本号，固定"200" |
| trace_no | String | 32 | Y | 请求流水号 |
| merchant_no | String | 15 | Y | 商户号 |
| begin_date | String | 8 | Y | 查询清算开始时间（yyyyMMdd） |
| end_date | String | 8 | Y | 查询清算结束时间（yyyyMMdd） |
| key_sign | String | 32 | Y | 签名检验串,,传参字典序+令牌（令牌名称为key），32位md5加密转换 |
以上为请求参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| return_code | String | 2 | Y | 响应码：“01”成功 ，02”失败，请求成功不代表业务处理成功 |
| return_msg | String | 128 | Y | 返回信息提示，“查询成功”，“请求受限”等 |
| trace_no | String | 32 | Y | 请求流水号 |
| result_code | String | 2 | N | 业务结果：“01”成功 ，02”失败 |
| merchant_no | String | 15 | N | 商户号 |
| settle_list | String | - | N | 清算查询结果集，JSONArray见settle_list解析 |
| key_sign | String | 32 | N | 签名检验串,传参字典序加令牌（令牌名称为key），32位md5加密转换 |
以上为响应参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| settle_date | String | 8 | Y | 清算日期（yyyyMMdd） |
| settle_amt | String | 11 | Y | 清算金额（分） |
| settle_status | String | 2 | Y | 清算状态（1 划款成功<表示已成功向银行发起划款，具体到账以银行通知为准> 2 划款失败 3 划款中 4 已划款，状态未知 <已经调用了划款接口，但是通道没有返回应答或返回了超时，无法判断是否成功，只能次日通过对账明确结果> |
| settle_status_msg | String | 128 | Y | 清算状态描述 |
| settle_channel_name | String | 20 | Y | 清算通道名称 |
以上为settle_list数组参数的元素对象属性