查询 PIX 代付

按商户订单号查询 PIX 代付状态。

接口

GET /cashout/pix/check

认证

Merchant Credential。详见 认证。

重要说明

警告

对于超时或者拿不到orderStatus值的情况，不要做任何订单状态判定

请求头

名称	位置	类型	必填	说明	示例
X-Nonce	header	string	是		a9f3c1d47e8b9a2c4d1f9e8a7b6c5d4e
X-Merchant-Id	header	string	是		2492265300
X-Timestamp	header	string	是		1638123456
Digest	header	string	是		SHA-256=Jr9cX0nM6yT7uF9GQ5G8ZC5M8vRZrQZP9+VbQ8Z8z0Q=
Authorization	header	string	是		Signature keyId="m123456",alg="ES256",headers="(request-target) x-timestamp x-nonce digest",signature="MEUCIQD8VxkzR7q5hF3k9dY0v6mKk7K0Nq9nYw+7Ck8LJr9mYAIgC5VQ7J0Z9YqL5F8Wc6E2Yw5qf1z8bYyYcR9kX8pY="

查询参数

名称	位置	类型	必填	说明	示例
mchOrderNo	query	string	否	商户订单号	order_{{$date.timestamp}}

响应

HTTP 200 — 成功

字段	类型	必填	说明
status	integer	是	状态
msg	null	是	信息
data	object	是

data 字段

字段	类型	必填	说明
mchOrderNo	string	是	商户订单号
platOrderNo	string	是	平台订单号
orderStatus	string	是	订单状态 (enum=SUCCESS, FAILED, PENDING, REFUND)
amount	number	是	订单金额
receivedAmount	number	否	到账金额
fee	number	是	手续费
toPix	string	是
toIspb	string	是
toName	string	是
fromBank	string	是
fromCnpj	string	是
fromName	string	是
toCpfCnpj	string	是
ispbName	string	是
payTime	integer	是	支付时间戳
errMsg	string	是	详细信息 — 错误时返回
e2eId	string	是	银行流水 — 成功时返回