提现接口 - 查询提现结果

查询提现结果

接口说明

接口描述：商户通过该接口查询提现订单状态和提现成功时的详细信息，支付网关会返回最新的数据。

适用对象：特约商户

请求URL：https://pay.yintongzaixian.com/api/cashout/order/query

请求方式：POST

请求类型：application/json 或 application/x-www-form-urlencoded

请求参数

字段名	变量名	必填	类型	示例值	描述
商户号	mchNo	是	String(30)	M1621873433953	商户号
应用ID	appId	是	String(32)	60cc09bce4b0f1c0b83761c9	应用ID
支付系统提现单号	cashoutOrderId	否	String(30)	C1789129338202107906	支付系统提现单号，与mchOrderNo二者传一即可
商户提现单号	mchOrderNo	否	String(30)	1715412578007	商户提现单号，与cashoutOrderId二者传一即可
请求时间	reqTime	是	long	1622016572190	请求接口时间,13位时间戳
接口版本	version	是	String(3)	1.0	接口版本号，固定：1.0
签名	sign	是	String(32)	C380BEC2BFD727A4B6845133519F3AD6	签名值，详见签名算法
签名类型	signType	是	String(32)	MD5	签名类型，目前只支持MD5或RSA2方式

请求示例数据

{
    "cashoutOrderId": "C1802947294409359361",
    "appId": "653b67b90d14f66aa119a518",
    "sign": "E630D5AEAF3A081EFD836CE0108DFE5E",
    "signType": "MD5",
    "reqTime": "1718793054",
    "mchNo": "M1698391993",
    "version": "1.0"
}

返回参数

字段名	变量名	必填	类型	示例值	描述
返回状态	code	是	int	0	0-处理成功，其他-处理有误，详见错误码
返回信息	msg	否	String(128)	签名失败	具体错误原因，例如：签名失败、参数格式校验错误
签名信息	sign	否	String(32)	CCD9083A6DAD9A2DA9F668C3D4517A84	对data内数据签名,如data为空则不返回
返回数据	data	否	String(512)	{}	返回下单

data数据格式

字段名	变量名	必填	类型	示例值	描述
商户号	mchNo	是	String(30)	M1621873433953	商户号
应用ID	appId	是	String(32)	60cc09bce4b0f1c0b83761c9	应用ID
支付接口	ifCode	是	String(24)	shengpay	支付接口，例如：shengpay-盛付通
支付系统提现单号	cashoutOrderId	是	String(30)	C12021022311124442600	支付系统提现单号
商户提现单号	mchOrderNo	是	String(30)	20160427210604000490	返回商户传入的提现单号
提现状态	state	是	int	2	提现状态: 0-提现单初始化, 1-提现中, 2-提现成功, 3-提现失败
申请提现金额	amount	是	int	100	申请提现金额,单位分
提现前余额	balance	是	int	1	提现前余额,单位分
渠道提现单号	channelOrderNo	否	String	20160427210604000490	对应渠道提现单号
渠道错误码	errCode	否	String	1002	渠道返回错误码
渠道错误描述	errMsg	否	String	134586944573118714	渠道返回错误描述
提现成功时间	successTime	是	long	1622016572190	提现成功时间,13位时间戳
提现银行名称	bankName	否	String(64)	中国农业银行	提现银行名称，提现成功时返回
提现账户	accountNo	否	String(64)	622180*********2659	提现账户，提现成功时返回
提现账户名称	accountName	否	String(64)	张三	提现账户名称，提现成功时返回
备注	remark	否	String(256)	134586944573118714	备注
创建时间	createdAt	是	long	1622016572190	订单创建时间,13位时间戳

返回示例数据

{
    "code": 0,
    "data": {
        "accountName": "张三",
        "accountNo": "622180*********2659",
        "amount": 1,
        "appId": "6563f0e90d146216c2003bcf",
        "bankName": "邮储银行",
        "cashoutOrderId": "C1802947294409359361",
        "channelOrderNo": "5909065809925273601117",
        "createdAt": 1718691106819,
        "ifCode": "shengpay",
        "mchNo": "M1698391993",
        "state": 2,
        "successTime": 1718691242000
    },
    "msg": "SUCCESS",
    "sign": "B8DEAA727973873A67F368E6A01E39F2"
}

SDK调用示例（Java）：

JeepayClient jeepayClient = JeepayClient.getInstance(Jeepay.appId, Jeepay.apiKey, Jeepay.getApiBase());
CashoutOrderQueryRequest request = new CashoutOrderQueryRequest();
CashoutOrderQueryReqModel model = new CashoutOrderQueryReqModel();
model.setMchNo(Jeepay.mchNo);                           // 商户号
model.setAppId(jeepayClient.getAppId());                 // 应用ID

request.setBizModel(model);
try {
    CashoutOrderQueryResponse response = jeepayClient.execute(request);
    _log.info("验签结果：{}", response.checkSign(Jeepay.apiKey));
    if (response.isSuccess(Jeepay.apiKey)) {
        _log.info("data：{}", response.getData());
    } else {
        _log.info("请求失败：mchNo={}, msg={}", Jeepay.mchNo, response.getMsg());
    }
} catch (JeepayException e) {
    _log.error(e.getMessage());
}

搜索结果

接口说明

请求参数

返回参数