接口文档
概述
查看此篇文章,想必你已经部署好了你的支付管理平台网站,
本文档介绍 前端如何自行快速接入 ipaybuy 支付管理系统,包括支付下单和查询支付记录等接口。
1. 支付下单接口
用于前端发起支付请求,返回订单id、支付二维码链接或支付跳转URL。
请求地址
POST /ipaybuy_api/pay
你的ipaybuy系统域名访问请求:http://xxx.com/ipaybuy_api/pay
请求参数
| 字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 支付方式 | pay_type | 是 | String | alipay | 支付方式(alipay/wxpay) |
| 商品名称 | title | 是 | String | VIP会员 | 商品的名称 |
| 商品金额 | money | 是 | String | 1.00 | 商品金额,单位元 |
| 文章ID | post_id | 是 | Int | 123 | 业务相关的文章ID |
| 用户ID | userid | 否 | Int | 1001 | 用户ID |
| OpenID | openid | 否 | String | openid | 微信/小程序OpenID |
| 设备ID | device_id | 是 | String | deviceid | 设备唯一标识 |
返回结果
| 字段名 | 变量名 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|
| 返回状态码 | code | Int | 1 | 1表示成功,其他为失败 |
| 返回信息 | msg | String | 成功 | 提示信息 |
| 订单id | trade_no | String | 20250608210850136140 | |
| 二维码 | qrcode | String | wxp://f2f0chC9qAWzXRFm5qRb...... | 二维码地址,微信非自定义图片或者支付宝才返回 |
| 金额 | money | String | 0.01 |
2. 查询支付记录接口
根据订单号、openid、device_id、userid+post_id 查询支付结果。
请求地址
GET /ipaybuy_api/pay_record
你的ipaybuy系统域名访问请求:http://xxx.com/ipaybuy_api/pay_record
请求参数
| 字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 商户订单号 | out_trade_no | 否 | String | 20240101123456 | 下单时生成的订单号 |
| OpenID | openid | 否 | String | openid | 微信/小程序OpenID |
| 设备ID | device_id | 是 | String | deviceid | 设备唯一标识 |
| 用户ID | userid | 否 | Int | 1001 | 用户ID |
| 文章ID | post_id | 是 | Int | 123 | 业务相关的文章ID |
返回结果
| 字段名 | 变量名 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|
| 是否成功 | success | Bool | true | true=支付成功,false=未支付 |
| 返回信息 | msg | String | 支付成功 | 提示信息 |
| 订单数据 | data | Object | 订单详细数据 |
data 字段说明
| 字段名 | 变量名 | 类型 | 示例值 | 说明 |
|---|---|---|---|---|
| 商户订单号 | out_trade_no | String | 202506081308522377 | 订单唯一编号 |
| 用户ID | userid | Int/String | 1001 | 用户ID,未传则为null |
| OpenID | openid | String | o6_bmjrPTlm6_2sgVt7hMZOP | 微信/小程序OpenID,未传则为空 |
| 设备ID | device_id | String | 1748682394627757213 | 设备唯一标识 |
| 文章ID | post_id | Int/String | 65 | 业务相关的文章ID |
| 商品标题 | title | String | 支付测试 | 订单商品名称 |
| 金额 | money | String | 0.01 | 订单金额,单位元 |
| 支付方式 | pay_type | String | 微信支付 | 支付方式(如"微信支付"、"支付宝支付") |
| 支付状态 | pay_status | String | 支付成功 | 订单状态 |
| 下单IP | ip | String | 112.94.76.65 | 下单时客户端IP |
| 创建时间 | create_time | String | 2025-06-08 21:08:52 | 订单创建时间 |
| 更新时间 | update_time | String | 2025-06-08 21:20:25 | 订单状态最后更新时间 |
3. 获取订单付款二维码接口
根据订单号order_id查询订单的付款二维码,用于渲染二维码给用户扫码支付。
请求地址
GET /ipaybuy_api/order_qrcode
你的ipaybuy系统域名访问请求:http://xxx.com/ipaybuy_api/order_qrcode
请求参数
| 字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 商户订单号 | order_id | 否 | String | 20240101123456 | 下单时会生成out_trade_no字段订单号,使用out_trade_no查询订单 |
返回结果
| 字段名 | 变量名 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|
| 是否成功 | success | Bool | true | true / false |
| 返回信息 | msg | String | 获取成功 | 提示信息 |
| 订单数据 | data | Object | 订单详细数据 |
data 字段说明
| 字段名 | 变量名 | 类型 | 示例值 | 说明 |
|---|---|---|---|---|
| 类型 | out_trade_no | String | qrcode | 类型:二维码 |
| 图片二维码地址 | qrcode_data | String | data:image/png;base64,rkJggg== | 图片二维码base64地址,前端可用图片组件加载 |
| qrcode二维码地址 | qrcode | String | wxp://f2f05G...FTDfesu_ | 微信/二维码编码需要用qrcode工具生成二维码 |
| scheme | scheme | String | 1748682394627757213 | 支付链接scheme |
| url | uri | String | 65 | 支付链接URL |
4. 订单状态说明
| 状态 | 说明 |
|---|---|
| 待支付 | 订单已创建,未支付 |
| 支付成功 | 支付平台回调成功 |
| 支付超时 | 超时未支付自动处理 |
| 支付异常 | 支付失败或回调异常 |
5. 其他说明
- 所有接口支持跨域(CORS),可直接前端调用
- 所有接口返回JSON格式
- 建议在生产环境中添加适当的错误处理和日志记录
- 如需更多参数或扩展,请联系开发者
iPayBuy