小程序开放平台

文档中心
API 简介
登录
接口调用凭证
小程序码与链接
小程序基础信息
本地担保交易能力
通用担保交易能力
业务接入流程
API列表
新增订单
获取支付token
订单查询
同步订单状态
新增售后
同步售后单状态
获取售后订单详情
结算明细查询
电商担保交易能力
地点管理能力
客服能力
群聊能力
小说能力
短剧能力
服务组件能力
直播能力

[交易组件]通用担保支付-新增订单

开发
>
服务端 API
>
通用担保交易能力
>
API列表
>
新增订单
>
更新时间:2025-05-22 21:15:40

支持第三方调用

支持沙箱环境调用

禁止个人开发者调用

只支持通用担保支付

请求地址

POST https://miniapp.xiaohongshu.com/api/rmp/mp/deal/general_gpay/order/upsert

公共请求参数

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

业务请求参数

名称
类型
是否必须
描述
out_order_idstring外部订单id
open_idstring用户openId
pathstring订单详情页的小程序路径,/开头
create_timeint64订单创建时间,时间戳精确到秒
expired_timeint64订单过期时间,时间戳精确到秒,最短5分钟,最长30分钟,为空默认30分钟
order_priceint64订单总价,单位到(分)
product_details
list_struct订单商品列表
name
string商品名称,不超过64个字符
desc
string商品描述,不超过128个字符
category_id
string类目id,小程序已审核通过的类目末级id
image
string商品图像,仅支持jpg、jpeg、png格式,图片大小不超过1m

请求示例

{
    "out_order_id":"string",
    "open_id":"string",
    "path":"string",
    "create_time":0,
    "expired_time":0,
    "order_price":0,
    "product_details":[
        {
            "name":"string",
            "desc":"string",
            "category_id":"string",
            "image":"string"
        }
    ]
}

响应参数

名称
类型
是否必须
描述
data
struct
out_order_id
string外部订单id
order_id
string小红书订单id
final_price
int64订单最终总价格
pay_token
string订单支付用 token,用于拉起小程序支付api
expired_time
int64订单支付到期时间,时间戳精确到秒
open_pay_type
string订单支付类型,跟商家的交易能力匹配
successbool是否成功
msgstring说明,正确响应时为 success,错误响应时为错误描述
codeint32错误码,正确响应时为 0,错误响应时非0

响应示例

{
    "data":{
        "out_order_id":"string",
        "order_id":"string",
        "final_price":0,
        "pay_token":"string",
        "expired_time":0,
        "open_pay_type":"string"
    },
    "success":true,
    "msg":"string",
    "code":0
}

业务错误码

参见错误码