代收订单查询
WARNING
最佳实践（必看）
- 对于支付成功的判定，需判定status和orderStatus状态，即status==200&&orderStatus="SUCCESS"
- 对于超时或者拿不到orderStatus，不要做任何修改和判定
接口
POST /cashin/bra/order/query
请求头
| 名称 | 必填 | 示例 | 说明 |
|---|---|---|---|
Content-Type | 是 | application/json | |
lang | 否 | en | 返回信息语言：zh中文，en英文，pt葡萄牙语 |
请求参数
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
sign | string | 是 | 验名 |
mchOrderNo | string | 否 | 商户订单号 — trxId、mchOrderNo、platOrderNo必传一个 |
mchId | integer | 是 | 商户号 |
timestamp | integer | 是 | 当前时间戳 — 秒级时间戳 |
trxId | string | 否 | 银行流水ID — trxId、mchOrderNo、platOrderNo必传一个；本字段支持前缀搜索 |
platOrderNo | string | 否 | 平台单号（推荐使用） — trxId、mchOrderNo、platOrderNo必传一个 |
请求示例
json
{
"mchId": 10004,
"timestamp": 11843534885,
"mchOrderNo": "order_1684465826",
"trxId": "E22896431202305180049FAR5NYPXF8l",
"sign": "xxxxxxxx"
}响应参数
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
status | integer | 是 | 状态 |
msg | string | 是 | 信息 |
data | object | 是 | 数据 |
data.orderStatus | string enum | 是 | 订单状态 — PENDING, SUCCESS, FAILED, REFUND |
data.amount | number | 是 | 实际支付金额 |
data.timeEnd | integer | 否 | 完结时间 — 时间戳单位秒 |
data.fee | string | 是 | 手续费用 |
data.mchOrderNo | string | 是 | 商户订单号 |
data.platOrderNo | string | 是 | 平台订单号 |
data.trxId | string | 是 | 银行流水ID |
data.payerName | string | 否 | 付款人姓名 |
data.taxNumber | string | 否 | 付款人CPF/CNPJ |
响应示例
json
{
"status": 200,
"msg": null,
"data": {
"mchOrderNo": "order_1662112944",
"platOrderNo": "P5nosqyWAQsQZNtYa5OW",
"trxId": "E00416968202309101937aZOHAzv6vkT",
"orderStatus": "PENDING",
"amount": "1200.00",
"fee": "14.00",
"payerName": "user name",
"taxNumber": "123456789012"
}
}