小白接口

9901 创建支付订单 App.Wxmini_Pay.CreateOrder

接口地址:http://open.phalapi.net/?s=App.Wxmini_Pay.CreateOrder

接口描述: 微信小程序,创建支付订单,支持App支付、JSAPI支付、Web支付、扫码支付等。如果你未接入在线支付,可以创建人工支付订单。

接口标签:免费(每月最高10万次)付费(包月/按量/私服)验签

请求协议
HTTP/HTTPS
请求方式
GET/POST(推荐POST)
编码格式
UTF-8
返回格式
JSON

在线测试    添加收藏    直接访问接口    我要调整此接口


接口参数 若无特殊说明,接口参数同时支持GET和POST传递;推荐:查询/删除用GET,创建/更新用POST。

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。
sign字符串可选公共参数 动态签名,签名生成算法请见:如何生成签名,或直接使用封装好的SDK开发包
如果不需要签名,可进入小白开放平台接口签名设置关闭或开启签名。通过在线测试工具可进行签名的对比和调试。 企业版支持专属签名算法定制。
uuid字符串可选最大:32公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。
token字符串可选最小:64;最大:64公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。
return_data字符串可选0公共参数 数据返回结构,其中:
  • return_data=0,返回完整的接口结果,示例:{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi,欢迎使用小白开放接口!"},"msg":"V3.1.0 YesApi App.Hello.World"}
  • return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}
trade_type枚举类型可选CASH范围:CASH/JSAPI/QRCODE/NATIVE/APP/H5/WXMINI支付类型:
  • CASH:人工结算支付(不走在线支付)
  • JSAPI:JSAPI支付
  • QRCODE:付款码支付
  • NATIVE:Native支付
  • APP:APP支付
  • H5:H5支付
  • WXMINI:小程序支付
body字符串必须商品名称,订单标题
total_fee字符串必须订单总金额,单位:分
openid字符串必须openid
notify_url字符串可选前台回调地址
customer_mobile字符串可选
customer_address字符串可选客户地址
customer_username字符串可选varchar
remark字符串可选客户备注,内部使用
goods_name字符串可选商品名称
goods_num字符串可选商品数量
goods_total_price字符串可选商品总价格,单位:分
goods_image字符串可选商品图片
more_params字符串可选更多订单参数,内部使用,推荐使用json格式。

在线测试

参数是否必填
s 必须
uuid 可选
token 可选
return_data 可选
trade_type 可选
body 必须
total_fee 必须
openid 必须
notify_url 可选
customer_mobile 可选
customer_address 可选
customer_username 可选
remark 可选
goods_name 可选
goods_num 可选
goods_total_price 可选
goods_image 可选
more_params 可选

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

请求:
{你的接口域名}/?s=App.Wxmini_Pay.CreateOrder&body=test&total_fee=1&openid=oes0R5asoorPZSLFyOBom1RrajnM&trade_type=CASH&app_key={你的app_key}&sign={动态签名}

返回:
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "options": null,
        "out_trade_no": "YAWM_202003211632036960"
    },
    "msg": "V1.5.1 小白开放接口 App.Wxmini_Pay.CreateOrder"
}
import yesapi from '../../utils/YesApi/yesapi.js';

在你的小程序中调用:  

let trade_type = 'CASH', 
    body = '测试商品', 
    total_fee = 1, 
    openid = 'oes0R5asoorPZSLFyOBom1RrajnM', 
    params = {
    customer_username: '张三',
                   customer_mobile: '13800000000',
                   customer_address: '广东广州天河',
    }

yesapi.requestAppWxmini_PayCreateOrde(trade_type, body, total_fee, openid, params, function (res) {
     console.log('创建订单:', res)
})

控制台输出:
创建订单: {"ret":200,"data":{"err_code":0,"err_msg":"","options":null,"out_trade_no":"YAWM_202003211717186796"},"msg":"V1.6.0 小白开放接口 App.Wxmini_Pay.CreateOrder"}

创建成功后,即可在管理后台查看订单,以及进行处理。  

依赖接口:
yesapi.requestAppWxmini_PayCreateOrde(trade_type, body, total_fee, openid, params, onSuccess, onError)



JS SDK 下载:https://github.com/yesapicn/yesapi-wxmini-sdk

接口使用帮助说明

小白君正在拼命补充中……

返回结构说明

返回字段类型说明
ret整型接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码
data.err_code整型操作码,0表示成功,正数表示业务失败场景,负数表示系统失败场景
data.err_msg字符串错误提示信息,err_code非0时参考此提示信息
data.options对象成功创建支付订单后返回给客户端的数据,失败时或人工支付时为null
data.out_trade_no字符串订单号
msg字符串提示信息,面向技术人员的帮助或错误提示信息

ret异常错误码

错误码错误类型错误描述信息解决方法
ret = 200成功请求成功
ret = 400客户端非法请求非法请求,参数错误1、根据接口文档的接口参数,提供正确的参数
ret = 404客户端非法请求接口服务不存在1、查看小白接口大全,确保接口服务名称拼写正确
ret = 500小白接口异常如果出现此错误,请联系技术人员处理1、进入QQ交流群897815708,反馈问题;2、或者提交工单,一天内回复
ret = 401客户端非法请求用户未登录,或登录凭证已过期1、如果用户未注册,请先用注册接口;2、如果注册未登录或会话过期,请先用登录接口
ret = 406客户端非法请求非法app_key,请核对你所在的接口域名1、在我的套餐查看并核对接口域名
ret = 407客户端非法请求当前应用已过期1、进行续费或续约,延长应用有效期
ret = 408客户端非法请求当前应用存在异常,已被封号1、联系在线客服人工处理
ret = 409客户端非法请求签名错误1、使用在线测试,校正签名;2、关闭特定或全部签名设置;3、如果过期,可以进行续约/升级
ret = 410客户端非法请求权限不足,非系统管理员1、应用权限不足,可联系在线客服咨询沟通
ret = 411客户端非法请求权限不足,应用管理员未登录1、请提供应用管理员的admin_uuid和admin_token参数后重试
ret = 412客户端非法请求权限不足,非应用管理员1、请在果创云把会员设置为管理员
ret = 413客户端非法请求本月接口流量超出,已被临时冻结1、开通接口流量叠加包,或升级套餐
ret = 414客户端非法请求并发过高1、请降低请求频率,检测是否有死循环调用,或是否被他人恶意使用。如果流量确实很大,可联系在线客服进行定制化或私有云部署。
ret = 415客户端非法请求接口已被开发者关闭1、接口已被开发者关闭,请进入果创云接口开关重新开启
ret = 416客户端非法请求权限不足,个人免费版套餐无法使用专业版接口1、请先升级终身会员/标准版/旗舰版/企业版

常见问题FAQ

Q1 问:出现 414 Request-URI Too Large 时怎么解决?答:对于全部参数,改用POST方式传递,并且从GET链接里面去掉。