订单支付状态

提供订单支付状态的精准查询能力，通过西月订单号快速获取该订单的当前状态及支付状态，适用于需要实时追踪订单支付情况的场景。

适用场景

单独查询某一订单的支付状态（待支付、支付成功、支付失败）

验证订单的当前状态（如：是否已取消、是否已发货）

对接支付流程，确认用户支付是否成功

接口类型

POST

请求频率限制

默认频率：以平台配额为准

请求说明

请求URL

正式环境：https://www.westmonth.com/openapi/v2/order/orderStatus
测试环境：https://testing.westmonth.com/openapi/v2/order/orderStatus

请求参数

Header参数

参数名	类型	必填	示例值	说明
Authorization	string	是	authorization	身份验证Token
Content-Type	string	是	application/json	建议固定传此值

Body参数

根字段

参数名	类型	必填	默认值	说明
orderNumber	string	是	-	西月订单号（如：aOP2505071626702）

响应字段说明

成功响应（HTTP 200）

根字段

字段	类型	说明
code	integer	业务状态码（0表示成功）
msg	string	提示信息（成功时为空）
data	object	订单支付状态详情

data对象字段

字段	类型	说明
number	string	西月订单号（与请求参数一致）
status	string	订单状态枚举值（如：unpaid、paid、cancelled、shipped）
pay_status	integer	支付状态 - 0：待支付 - 1：支付成功 - 2：支付失败

调用示例

URL请求

请求示例

{
    "orderNumber": "aOP2505071626702"
}

成功返回示例

{
    "code": 0,
    "msg": "",
    "data": {
        "number": "aOP2505071626702",
        "status": "unpaid",
        "pay_status": 0
    }
}

失败返回示例

{
    "code": 3,
    "msg": "授权无效 authorization timestamp error",
    "data": []
}

错误处理

公共错误码

HTTP status code	错误码	错误信息	描述

版本历史

版本	日期	修改说明
v1.0	2025-03-01	初始版本，支持订单支付状态查询

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

application/json

Bodyapplication/json

示例

{
    "code": 0,
    "msg": "",
    "data": {
        "number": "aOP2505071626702",
        "status": "unpaid",
        "pay_status": 0
    }
}

订单支付状态

订单支付状态#

适用场景#

接口类型#

请求频率限制#

请求说明#

请求参数#

Header参数#

Body参数#

响应字段说明#

调用示例#

URL请求#

请求示例#

成功返回示例#

失败返回示例#

错误处理#

版本历史#

请求参数

请求示例代码

返回响应

订单支付状态

适用场景

接口类型

请求频率限制

请求说明

请求参数

Header参数

Body参数

响应字段说明

调用示例

URL请求

请求示例

成功返回示例

失败返回示例

错误处理

版本历史