获取订单支付信息

提供获取西月订单支付相关信息的能力，支持批量查询多个订单的支付详情，包括订单数量、商品数量、总金额、支付方式等信息。

适用场景

查询订单的支付信息

批量获取多个订单的支付相关详情

接口类型

POST

请求频率限制

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

请求说明

请求URL

正式环境：https://www.westmonth.com/openapi/pay/payInfo
测试环境：https://testing.westmonth.com/openapi/pay/payInfo

请求参数

Header参数

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

Body参数

根字段

参数名	类型	必填	默认值	可选值	说明
orderNumberList	array	是	-	-	西月订单号，一维数组形式传递

响应字段说明

成功响应（HTTP 200）

根字段

字段	类型	说明
code	integer	业务状态码（0表示成功）
msg	string	提示信息（成功时为空）
data	object	业务数据

data对象字段

字段	类型	说明
orderCount	integer	订单数
productTypeCount	integer	商品种类
productCount	integer	商品数量
totalAmount	string	应付金额
ring_stock_data	object	圈货/备货数据
allow_payments	array	允许支付方式，数组中为支付方式对应的编码

ring_stock_data对象字段

字段	类型	说明
has_ring_stock_order	boolean	是否有圈货订单（true / false）
currency_code	string	圈货/备货预付款比重
amounts	object	金额相关信息
is_prepay	boolean	是否使用预付款
ring_stock_no	string	圈货单号
ring_stock_batch	string	圈货批次
ring_stock_type	null	类型（0:圈货，1:备货）
ring_stock_type_name	null	类型名称（圈货 / 备货）
ring_stock_qty	integer	圈货/备货当前订单使用库存
ring_stock_available_stock	integer	圈货/备货剩余可使用库存

amounts对象字段

字段	类型	说明
orig_total_amount	string	原始总金额
total_amount	string	总金额
total_amount_format	string	格式化的总金额（带货币符号）
prepay_amount	integer	预付款金额
prepay_amount_format	string	格式化的预付款金额（带货币符号）
other_prepay_amount	string	其他预付款金额
other_prepay_amount_format	string	格式化的其他预付款金额（带货币符号）
ring_stock_left_prepay_amount	integer	圈货剩余预付款金额
ring_stock_left_prepay_amount_format	string	格式化的圈货剩余预付款金额（带货币符号）

调用示例

URL请求

请求示例

成功返回示例

{
    "code": 0,
    "msg": "",
    "data": {
        "orderCount": 3,
        "productTypeCount": 2,
        "productCount": 7,
        "totalAmount": "138.00",
        "ring_stock_data": {
            "currency_code": "CNY",
            "amounts": {
                "orig_total_amount": "138.00",
                "total_amount": "138.00",
                "total_amount_format": "￥138.00",
                "prepay_amount": 0,
                "prepay_amount_format": "￥0.00",
                "other_prepay_amount": "138.00",
                "other_prepay_amount_format": "￥138.00",
                "ring_stock_left_prepay_amount": 0,
                "ring_stock_left_prepay_amount_format": "￥0.00"
            },
            "is_prepay": false,
            "ring_stock_no": "",
            "ring_stock_batch": "",
            "ring_stock_type": null,
            "has_ring_stock_order": false,
            "ring_stock_type_name": null,
            "ring_stock_qty": 0,
            "ring_stock_available_stock": 0
        },
        "allow_payments": [
            1,
            2,
            3,
            4,
            5,
            6
        ]
    }
}

失败返回示例

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

错误处理

公共错误码

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

常见问题

Q1：查询不到订单支付信息可能是什么原因？

A：可能是以下原因导致：

订单号错误，确认orderNumberList中的西月订单号是否正确；

授权无效，检查Authorization是否正确；

订单尚未创建或已被删除。

Q2：allow_payments数组中的数字分别代表什么支付方式？

A：具体支付方式对应的编码可参考平台提供的支付方式说明文档，不同编码对应不同的支付渠道。

版本历史

版本	日期	修改说明
v1.0	2025-01-01	初始版本

application/json

Bodyapplication/json

示例

{
    "code": 0,
    "msg": "",
    "data": {
        "orderCount": 3,
        "productTypeCount": 2,
        "productCount": 7,
        "totalAmount": "138.00",
        "ring_stock_data": {
            "currency_code": "CNY",
            "amounts": {
                "orig_total_amount": "138.00",
                "total_amount": "138.00",
                "total_amount_format": "￥138.00",
                "prepay_amount": 0,
                "prepay_amount_format": "￥0.00",
                "other_prepay_amount": "138.00",
                "other_prepay_amount_format": "￥138.00",
                "ring_stock_left_prepay_amount": 0,
                "ring_stock_left_prepay_amount_format": "￥0.00"
            },
            "is_prepay": false,
            "ring_stock_no": "",
            "ring_stock_batch": "",
            "ring_stock_type": null,
            "has_ring_stock_order": false,
            "ring_stock_type_name": null,
            "ring_stock_qty": 0,
            "ring_stock_available_stock": 0
        },
        "allow_payments": [
            1,
            2,
            3,
            4,
            5,
            6
        ]
    }
}

获取订单支付信息

获取订单支付信息

适用场景

接口类型

请求频率限制

请求说明

请求参数

Header参数

Body参数

响应字段说明

调用示例

URL请求

请求示例

成功返回示例

失败返回示例

错误处理

常见问题

Q1：查询不到订单支付信息可能是什么原因？

Q2：allow_payments数组中的数字分别代表什么支付方式？

版本历史

请求参数

请求示例代码

返回响应

获取订单支付信息

获取订单支付信息#

适用场景#

接口类型#

请求频率限制#

请求说明#

请求参数#

Header参数#

Body参数#

响应字段说明#

调用示例#

URL请求#

请求示例#

成功返回示例#

失败返回示例#

错误处理#

常见问题#

Q1：查询不到订单支付信息可能是什么原因？#

Q2：allow_payments数组中的数字分别代表什么支付方式？#

版本历史#

请求参数

请求示例代码

返回响应

获取订单支付信息

适用场景

接口类型

请求频率限制

请求说明

请求参数

Header参数

Body参数

响应字段说明

调用示例

URL请求

请求示例

成功返回示例

失败返回示例

错误处理

常见问题

Q1：查询不到订单支付信息可能是什么原因？

Q2：allow_payments数组中的数字分别代表什么支付方式？

版本历史