订单 API - ipayxx API 文档

POST/v1/orders

创建订单

创建一笔新的支付订单。成功后会返回收银台地址，引导用户完成支付。

请求参数

参数	类型	必填	说明
`product_id`	string	是	商品 ID
`amount`	integer	是	金额，单位为分
`currency`	string	否	货币代码，默认 CNY
`description`	string	是	订单描述
`buyer_email`	string	否	买家邮箱，用于接收订单通知
`metadata`	object	否	自定义元数据，最多 10 个键值对
`return_url`	string	否	支付成功后的跳转地址

请求示例

curl -X POST https://api.ipayxx.cn/v1/orders \
  -H "Authorization: Bearer sk_test_xxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "product_id": "prod_pro_license",
    "amount": 29900,
    "currency": "CNY",
    "description": "专业版许可证 - 永久授权",
    "buyer_email": "[email protected]",
    "return_url": "https://example.com/success",
    "metadata": {
      "user_id": "u_12345"
    }
  }'

响应示例

{
  "code": 0,
  "message": "success",
  "data": {
    "order_no": "ORD20260308100001",
    "product_id": "prod_pro_license",
    "status": "unpaid",
    "amount": 29900,
    "currency": "CNY",
    "description": "专业版许可证 - 永久授权",
    "pay_url": "https://pay.ipayxx.cn/checkout/ORD20260308100001",
    "return_url": "https://example.com/success",
    "expires_at": "2026-03-08T11:00:00Z",
    "created_at": "2026-03-08T10:00:00Z"
  }
}

GET/v1/orders/:order_no

查询订单

通过订单号查询订单详情及当前状态。

路径参数

参数	类型	说明
`order_no`	string	订单编号

请求示例

curl https://api.ipayxx.cn/v1/orders/ORD20260308100001 \
  -H "Authorization: Bearer sk_test_xxxxxxxxxxxx"

响应示例

{
  "code": 0,
  "message": "success",
  "data": {
    "order_no": "ORD20260308100001",
    "product_id": "prod_pro_license",
    "status": "paid",
    "amount": 29900,
    "currency": "CNY",
    "description": "专业版许可证 - 永久授权",
    "buyer_email": "[email protected]",
    "paid_at": "2026-03-08T10:05:32Z",
    "license_key": "LIC-ABCD-EFGH-IJKL-MNOP",
    "created_at": "2026-03-08T10:00:00Z"
  }
}

订单状态说明

状态	说明
`unpaid`	待支付，等待用户完成付款
`paid`	已支付，支付成功
`cancelled`	已取消，订单超时未支付或主动取消
`refunded`	已退款