目录

应用购买记录相关支付订单查询

功能介绍

此接口用于查询指定时间范围内购买记录相关的付款和退款订单。

场景描述

例如:当您想查看前一天购买记录相关的付款和退款订单时,您可以指定开始时间为前一天的0点,结束时间为今天的0点,调用此接口查询相关订单。

由于当天的实时订单信息还有可能变化,因此不建议使用此接口查询当天的实时订单数据,建议延迟一天查询。

接口原型

承载协议

HTTPS POST

接口方向

开发者服务器-> 华为应用内支付服务器

接口URL

{rootUrl}/applications/v1/merchantQuery

说明:

rootUrl在不同站点有不同的url:您应固定选择最近站点的Order服务地址访问。具体请参见站点信息和站点选择。

数据格式

请求消息:Content-Type: application/json

响应消息:Content-Type: application/json

请求参数

Request Header

参数

是否必选

参数类型

描述

Content-Type

是

String

取值为:application/json; charset=UTF-8

Authorization

是

String

认证信息,使用Access Token进行鉴权,这里使用开放平台鉴权提供的服务接口获取Access Token,格式说明参见公共说明,获取方式参见获取应用级AT。

Request Body

参数

是否必选

参数类型

描述

startAt

是

Long

指定时间范围的开始时间,UTC时间戳,以毫秒为单位。startAt不能大于当前时间。支付时间(tradeTime)大于此时间的订单才会被查询出来。

endAt

是

Long

指定时间范围的结束时间,UTC时间戳,以毫秒为单位。endAt与startAt时间差为48小时或者48小时内。endAt必须大于startAt。支付时间(tradeTime)小于此时间的订单才会被查询出来。

continuationToken

否

String

输入上次查询返回的continuationToken以查询下一页数据。

请求示例

POST /applications/v1/merchantQuery
Content-Type: application/json; charset=UTF-8
Authorization: Basic QVQ6Q1YzQ1NPbVlBaGwrZUtRWExtMTBVV2pyWXZHTVF4MmYvcVMya1B0ZElLY3UwaFJrdFNTMmxwdk1FQkIyYldXWGt0REVaR3I4UjFUTTRLMVlmNXdwWU80RG04THdXQWxjaFhEYjBMUjBNTUJtWnFYcGFtazc3THN3UnFJbkhHK28xekdqRzNSMg==
Accept: application/json
Content-Length: 98
{
  "startAt": 1666800000000,
  "endAt": 1666886400000
}

响应参数

Response Header

参数

是否必选

参数类型

描述

Content-Type

是

String

取值为:application/json; charset=UTF-8

Response Body

参数

是否必选

参数类型

描述

responseCode

是

String

返回码。

  • 0:成功。
  • 其他:失败,具体请参见错误码。

responseMessage

否

String

响应描述。

orderInfoList

否

JSONArray

订单信息列表,其中每个JSONObject表示一个订单信息,订单信息格式参见下表OrderInfo。

continuationToken

否

String

表示下一页数据,如果返回,可以输入下一次查询请求,以此查询下一页数据。

表1 OrderInfo

参数

是否必选

参数类型

描述

orderNo

是

String

华为订单号。

requestId

是

String

商户请求号。

country

是

String

国家/地区码,用于区分国家/地区信息,请参见ISO 3166标准。

merchantId

是

String

商户ID。

applicationId

是

String

应用ID。

orderTime

是

Long

下单时间,UTC时间戳,以毫秒为单位。

tradeTime

是

Long

支付时间,UTC时间戳,以毫秒为单位。

productId

是

String

商品SKU。

productName

是

String

商品名称。

payMoney

是

String

支付金额,单位为元。

couponAmt

否

String

优惠券金额,单位为元。

mpAmt

否

String

积分抵扣金额,单位为元。

mpRfdAmt

否

String

积分退款金额,单位为元。

currency

是

String

币种。

payType

是

Integer

支付方式,取值请参见payType说明。

tradeState

是

Integer

订单状态,取值如下:

  • 0:成功
  • 2:失败
  • 4:未支付

tradeType

是

String

交易类型,取值如下:

  • PURCHASE:支付
  • REFUND:退款

oriOrderNo

否

String

原始华为订单号,退款原始订单,当tradeType为REFUND时返回。

refundTime

否

Long

退款时间,UTC时间戳,以毫秒为单位。

refundMoney

否

String

退款金额,单位为元。

响应示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
Content-Length: 455
{
    "responseCode": "0",
    "orderInfoList": [
        {
            "orderNo": "V202209272021234015A069C79",
            "requestId": "20220927202901112349187041.101721234",
            "country": "CN",
            "merchantId": "9000860001552381234",
            "applicationId": "101721234",
            "orderTime": 1664281771000,
            "tradeTime": 1664281771000,
            "productId": "ballcost04",
            "productName": "abc",
            "payMoney": "10.00",
            "couponAmt": "0.10",
            "currency": "CNY",
            "payType": 4,
            "tradeState": 0,
            "tradeType": "PURCHASE"
        }
    ],
  "continuationToken": "eyJwYWdlU2l6ZSI6MSwicG9zaXRpb24iOiIxNTc2MDczODYzMTQyLjk4MEMzMDFFLjI5MzcifQ=="
}

Postman调试

您可以使用Postman在线调试此接口。