按 E2E ID 查询支付

按 PIX E2E ID 查询支付状态。

接口

GET /cashin/pix/check-qrcode

认证

Merchant Credential。详见 认证。

重要说明

警告

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

说明

• 请注意校验payAmount

请求头

名称	位置	类型	必填	说明	示例
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="

查询参数

名称	位置	类型	必填	说明	示例
e2eId	query	string	是	银行交易ID	E00416968202309101937aZOHAzv6vkT

响应

HTTP 200 — 成功

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

data 字段

字段	类型	必填	说明
orderStatus	string	是	订单状态 (enum=PENDING, SUCCESS, FAILED, REFUND)
amount	number	是	订单金额
fee	number	是	手续费用
mchOrderNo	string	是	商户订单号
platOrderNo	string	是	平台订单号
payerName	string	否	付款人信息 — 付款人姓名
payerDocument	string	否	付款人Cpf或者Cnpj
payAmount	number	是	实际支付金额 — 实际支付金额
e2eId	string	是	银行流水ID — 银行交易ID
applyTime	integer	是	申请时间戳，单位秒
payTime	integer	否	完结时间 — 支付时间戳，单位秒
expireTime	integer	是	过期时间戳，单位秒

响应示例

{
  "status": 200,
  "msg": null,
  "data": {
    "mchOrderNo": "order_1662112944",
    "platOrderNo": "P5nosqyWAQsQZNtYa5OW",
    "e2eId": "E00416968202309101937aZOHAzv6vkT",
    "orderStatus": "PENDING",
    "amount": 1200,
    "payAmount": 1200,
    "fee": 14,
    "payerName": "Name",
    "payerDocument": "3777882312",
    "payTime": 1670178905,
    "applyTime": 1670178805,
    "expireTime": 1670188805
  }
}