Skip to content

支付-查询订单 ​

本接口应在服务器端调用,严禁在前端(APP 客户端、网页、小游戏等)直接调用,避免凭证泄露风险。

接口说明 ​

接口英文名 pay.orderQuery

功能描述 查询支付订单。

注意:本接口强制要求服务通信二次加密和签名:请求参数必须加密并携带签名,响应必须验签后再解密,可有效防止数据篡改与泄露。

调用方式 ​

HTTPS 调用 ​

http
POST /v1/pay/order/query?access_token=ACCESS_TOKEN

调用时,请在接口路径前拼接游戏所属服务区域的基础地址,详见服务区域与接口地址。

请求参数 - Query ​

属性类型默认值必填说明
access_tokenstring是接口调用凭证

请求参数 - Body ​

属性类型默认值必填说明
openidstring是用户唯一标识
envnumber是环境配置 0-正式环境,1-沙箱环境
out_trade_nostring是业务订单号

返回值 ​

返回的 JSON 数据包

属性类型说明
errcodeint32错误码
errmsgstring错误信息
modestring支付类型,当前支持的类型有:goods、coin
product_idstring商品id
product_namestring商品名称
quantitynumber购买数量
unit_pricenumber商品单价(分)
currencystring币种: CNY
out_trade_nostring业务订单号
sud_trade_nostringSUD订单号
envnumber环境配置 0-正式环境,1-沙箱环境
statusstring状态,枚举类:PAYING-支付中,PAID-支付成功,CLOSED-已关闭,DELIVERED-已发货,REFUNDING-退款中,REFUNDED-已退款,REFUND_FAIL-退款失败
attachstring透传数据

调用示例 ​

cURL 请求 ​

bash
# 中国大陆示例;其他区域请使用对应的基础地址。
BASE_URL='https://cn-cpapi.sudbiz.cloud'

curl -X POST \
  "${BASE_URL}/v1/pay/order/query?access_token=ACCESS_TOKEN" \
  -H 'Content-Type: application/json; charset=utf-8' \
  -d '{
  "openid": "IGT6kPzX79FXgkDyMusgRaavLUZj63UnzkZRCnuzOuYC4g",
  "env": 0,
  "out_trade_no": "order_20231024123456"
}'

请求数据示例 ​

json
{
  "env": 0,
  "out_trade_no": "order_20231024123456"
}

返回数据示例 ​

json
{
  "errcode": 0,
  "errmsg": "ok",
  "mode": "goods",
  "product_id": "item_001",
  "product_name": "100金币",
  "quantity": 1,
  "unit_price": 600,
  "currency": "CNY",
  "out_trade_no": "order_20231024123456",
  "sud_trade_no": "sud_20231024123456",
  "env": 0,
  "status": "PAID",
  "attach": "custom_passthrough_data"
}