文档中心 > API类目 > 零售终端API

qimen.tmall.nrt.pay.status.get (获取支付状态)

获取支付状态

公共参数

请求地址：

环境	HTTP请求地址
正式环境	http://qimen.api.taobao.com/router/qm
测试环境	http://qimen.api.taobao.com/router/qmtest

公共请求参数：

名称	类型	是否必须	描述
method	String	是	API接口名称。
app_key	String	是	TOP分配给应用的AppKey。
session	String	否	用户登录授权成功后，TOP颁发给应用的授权信息，详细介绍请点击这里。当此API的标签上注明：“需要授权”，则此参数必传；“不需要授权”，则此参数不需要传；“可选授权”，则此参数为可选。
timestamp	String	是	时间戳，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8，例如：2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟。
format	String	否	响应格式。默认为xml格式，可选值：xml，json。
v	String	是	API协议版本，可选值：2.0。
customerId	String	是	WMS颁发给用户的ID
sign_method	String	是	签名的摘要算法，md5。
sign	String	是	API输入参数签名结果，签名算法介绍请点击这里。

请求参数

名称	类型	是否必须	示例值	更多限制	描述
pay_detail_id	Number	必须	1221111122		支付单流水号

响应参数

名称	类型	示例值	描述
result	TopResultDO		返回结果
└ err_msg String 系统错误错误信息 └ err_code String sys_err 错误码 data PayStatusRespDTO 返回数据 └ pay_status Number 6 支付状态（3.未决，4.失败，6成功） └ agency_end_time String 2021-07-29 10:00:00 支付完成时间 └ success Boolean false 服务端成功失败

请求示例

{"pay_detail_id":1221111122}

响应示例

{
    "result":{
        "err_msg":"系统错误",
        "err_code":"sys_err",
        "data":{
            "pay_status":6,
            "agency_end_time":"2021-07-29 10:00:00"
        },
        "success":false
    }
}

验签示例

{"result":{"success":"false","err_msg":"Illegal request","err_code":"sign-check-failure"}}

错误码解释

错误码	错误描述	解决方案

API工具

错误码查询工具 SDK下载

FAQ

有用( 0 ) 我要提问

返回
顶部

开放平台

零售终端API

qimen.tmall.nrt.pay.status.get (获取支付状态)

公共参数

请求参数

响应参数

请求示例

响应示例

验签示例

错误码解释

API工具

FAQ