小程序开放平台

文档中心
API 简介
登录
接口调用凭证
小程序码与链接
小程序基础信息
本地担保交易能力
业务接入流程
API列表
商品-获取信息
商品-批量获取信息
商品同步-生活服务
专业号主页商品排序
sku商品-批量删除
sku商品-批量上架
sku商品-批量下架
订单新增
订单-状态同步
获取订单支付token
担保支付订单-获取订单信息
凭证核销
预约单状态同步
发起预约
售后单-新增
同步售后单状态
获取售后订单详情
查询结算
结算咨询
结算明细查询
查询核销信息
通用担保交易能力
电商担保交易能力
地点管理能力
客服能力
群聊能力
小说能力
短剧能力
服务组件能力
直播能力

[交易组件]担保支付订单-获取订单信息

开发
>
服务端 API
>
本地担保交易能力
>
API列表
>
担保支付订单-获取订单信息
>
更新时间:2025-05-22 21:08:18

支持第三方调用

支持沙箱环境调用

禁止个人开发者调用

请求地址

POST https://miniapp.xiaohongshu.com/api/rmp/mp/deal/gpay_order/get

公共请求参数

名称
类型
是否必须
描述
app_idstring小程序appid
access_tokenstring小程序调用凭证

业务请求参数

名称
类型
是否必须
描述
out_order_idstring外部订单id,支持预约单号(即:out_book_order_id),或者预售/团购的主单号
open_idstring用户 id
order_typeint321: 主单(预售券/团购券) 2:预约单(预售券/日历订单
ext_infostring扩展参数,json格式

请求示例

{
    "out_order_id":"string",
    "open_id":"string",
    "order_type":0,
    "ext_info":"string"
}

响应参数

名称
类型
是否必须
描述
data
struct
order_id
string小红书订单ID,可能为空(如果是0元预售券的预约差价单)
pay_amount
int64支付金额,可能为0(如果是0元预售券的预约差价单)
order_status
int32订单状态,1:待支付,6:已支付,7:已完成(订单走到终态,进入结算流程),71:已关闭,998:已取消
voucher_infos
list_struct凭证明细,对于预售/团购的主单,同时订单是已支付状态,该字段有值
voucher_code
string凭证code
voucher_status
int32状态 1:待使用 2:已使用 3:已作废(全额退款) 4:已冻结(比如一张券发起了预约,此时商家未接单)
pay_amount
int64预售券主单返回资金明细
biz_id
string业务 ID
book_details
list_struct预约明细,对于预售/团购的主单,同时订单是已支付状态,该字段有值
book_id
string小红书侧预约id,服务商侧建立mapping关系,后续的预约单状态同步,退款交互都基于该单号
voucher_code
string预约的凭证code(日历商品为空)
book_status
int32状态 0:初始化 1:待支付 2:待商家确认 3:已确认 4:已拒绝 5:已取消(比如预约单超时未支付) 6:已完成(到了checkout,进入结算流程)
product_infos
list_struct订单商品明细
out_product_id
string外部商品
out_sku_id
string外部sku商品Id
num
int32购买的商品数量
sale_price
int64商品原始售卖价格,该商品单个原价 * num 之和,单位(分)
real_price
int64商品最终售卖价格,该商品原始售卖价格 - 优惠价格,单位(分)
image
string生成订单时商品的实际图片,建议定制品商品下使用,普通商品不建议使用。如果图片违规3次将被停用此功能
discount_infos
list_struct优惠信息
name
string费用项
price
int64费用之和,单位到(分)
num
int32项目数量,必须大于0
third_trade_no
string支付单号
pay_channel
int32支付渠道,1:微信,2:支付宝
successbool是否成功
msgstring说明,正确响应时为 success,错误响应时为错误描述
codeint32错误码,正确响应时为 0,错误响应时非0

响应示例

{
    "data":{
        "order_id":"string",
        "pay_amount":0,
        "order_status":0,
        "voucher_infos":[
            {
                "voucher_code":"string",
                "voucher_status":0,
                "pay_amount":0,
                "biz_id":"string"
            }
        ],
        "book_details":[
            {
                "book_id":"string",
                "voucher_code":"string",
                "book_status":0
            }
        ],
        "product_infos":[
            {
                "out_product_id":"string",
                "out_sku_id":"string",
                "num":0,
                "sale_price":0,
                "real_price":0,
                "image":"string",
                "discount_infos":[
                    {
                        "name":"string",
                        "price":0,
                        "num":0
                    }
                ]
            }
        ],
        "third_trade_no":"string",
        "pay_channel":0
    },
    "success":true,
    "msg":"string",
    "code":0
}

业务错误码

参见错误码