# 一、可提现余额查询
# 1) 说明
查询用户可用于提现的金额
# 2) 请求地址
/trade/queryBalance
# 3) 调用方式：HTTP POST form-data
# 4) 请求参数:
| 参数名 | 字段名 | 格式 | 必填 | 说明 |
|---|---|---|---|---|
| mid | 商户 | Long(20) | 是 | 商户进件成功后由蝉鸣分配的商户唯一ID |
| sourceCode | 通道编号 | String(30) | 是 | 富友(FY) 平安(PABANK) 民生(CMBCBANK) |
# 5) 业务响应参数:
| 参数名 | 字段名 | 格式 | 必填 | 说明 |
|---|---|---|---|---|
| mid | 商户id | Long(20) | 是 | 商户进件成功后由蝉鸣分配的商户唯一ID |
| total | 账面余额 | Long(20) | 是 | 账户总金额，available+freeze |
| available | 可用余额 | Long(20) | 是 | 可提现金额 |
| freeze | 冻结余额 | Long(20) | 是 | 冻结的总金额，包含手续费 |
| balanceStatus | 分账状态 | boolean | 否 | 目前只有平安银行会判断,分账状态：false(分账中);true(分账完成) |
# 二、提现接口
# 1) 说明
提现余额到银行卡
# 2) 请求地址
/trade/withdraw
# 3) 调用方式：HTTP POST form-data
# 4) 请求参数:
| 参数名 | 字段名 | 格式 | 必填 | 说明 |
|---|---|---|---|---|
| mid | 商户id | Long(20) | 是 | 商户进件成功后由蝉鸣分配的商户唯一ID |
| sourceCode | 通道编号 | String(30) | 是 | 平安(PABANK) 民生(CMBCBANK) |
| amount | 提现金额 | Long(20) | 是 | 提现金额，单位分 |
| bizSerialNo | 流水号 | String(64) | 是 | 业务方的流水号 |
| notifyUrl | 提现金额 | String | 是 | 当提现成功或失败时，回调业务方地址 |
| remark | 提现备注 | String(100) | 否 | 提现备注 |
# 5) 业务响应参数:
| 参数名 | 字段名 | 格式 | 必填 | 说明 |
|---|
# 三、代付接口
# 1) 说明
富友，民生通道私户提现到银行卡
# 2) 请求地址
/trade/transfer
# 3) 调用方式：HTTP POST form-data
# 4) 请求参数:
| 参数名 | 字段名 | 格式 | 必填 | 说明 |
|---|---|---|---|---|
| mid | 商户id | Long(20) | 是 | 商户进件成功后由蝉鸣分配的商户唯一ID |
| outOrderNo | 提现唯一编号 | String(64) | 是 | 现唯一编号 |
| sourceCode | 通道编号 | String(32) | 是 | 富友(FY) 民生(CMBCBANK) |
| branchNo | 支行号 | String(32) | 是 | 支行号 |
| bankCode | 银行编号 | String(32) | 是 | 银行编号 |
| toAccountNo | 银行卡号 | String(32) | 是 | 银行卡号 |
| toAccountName | 银行户名 | String(32) | 是 | 银行户名 |
| desc | 描述 | String(32) | 是 | 描述 |
| amount | 提现金额 | String(32) | 是 | 提现金额:单位分 |
| notifyUrl | 回调地址 | String(32) | 是 | 回调地址 |
| toAccountType | 账户类型 | String(32) | 是 | 账户类型（01 私户 ;02 公户） |
# 5) 业务响应参数:
| 参数名 | 字段名 | 格式 | 必填 | 说明 |
|---|---|---|---|---|
| orderNo | 支付中心编号 | String(32) | 是 | 支付中心编号 |
| outTradeNo | 外部编号 | String(32) | 是 | 平台商户端的唯一编号，用来和蝉鸣交易关联 |
| acceptStatus | 受理状态 | String(10) | 是 | 受理状态 0：受理失败，1:受理成功，2:成功，3:失败 |
| acceptDesc | 状态描述 | String(32) | 是 | 状态描述 |
# 四、提现回调
# 1) 说明
提现通知提现方提现结果
# 2) 调用方式：HTTP POST form-data
# 3) 请求参数:
| 参数名 | 字段名 | 格式 | 必填 | 说明 |
|---|---|---|---|---|
| mid | 商户id Long(20) | 是 | 商户进件成功后由蝉鸣分配的商户唯一ID | |
| bizSerialNo | 流水号 | String(64) | 是 | 业务方的流水号 |
| amount | 提现金额 | Long(20) | 是 | 提现金额，单位分 |
| state | 获取提现状态 | String(64) | 是 | 获取提现状态. I:初始(Init) S:成功(Success) F:失败(Fail) P:正在处理(Processing) |
| businessType | 提现交易通知业务分类编号 | String(64) | 是 | WITHDRAW_SYNC 提现交易通知 |
| finishTime | 通知时间 | timestamp | 是 | 通知时间 |
| failReason | 失败原因 | string | 否 | 提现失败时会返回原因 |
| sign | 签名 | String | 是 |
# 4) 业务响应参数:
返回字符串 SUCCESS，其他都认为失败
# 五、代付回调
# 1) 说明
代付转账通知提现方代付结果
# 2) 调用方式：HTTP POST form-data
# 3) 请求参数:
| 参数名 | 字段名 | 格式 | 必填 | 说明 |
|---|---|---|---|---|
| mid | 商户id | Long(20) | 是 | 商户进件成功后由蝉鸣分配的商户唯一ID |
| outOrderNo | 流水号 | String(64) | 是 | 业务方的流水号 |
| amount | 提现金额 | Long(20) | 是 | 提现金额，单位分 |
| state | 获取提现状态 | String(64) | 是 | 获取提现状态. "0"交易失败，"1"为交易成功, "2"为退票成功。 "3"为交易正在处理，"4"为退票失败, "5"为退票正在处理。 |
| businessType | 提现交易通知业务分类编号 | String(64) | 是 | WITHDRAW_SYNC 提现交易通知 |
| upOrderNo | 蝉鸣的订单号 | String(64) | 是 | 蝉鸣的订单号 |
| result | 交易结果描述 | timestamp | 是 | 交易结果描述 |
| transferDate | 交易日期 | string | 否 | 交易日期 |
| tpDate | 退票日期 | string | 否 | 退票日期 |
| sign | 签名 | String | 是 |
# 4) 业务响应参数:
返回字符串 SUCCESS，其他都认为失败