文档中心

提供完整的API接口文档和开发指南

API接口

支付接口
统一下单
JSAPI支付
APP支付
小程序支付
订单接口
订单查询
订单关闭
退款接口
申请退款
退款查询
查询接口
交易查询
余额查询
通知接口
支付结果通知
退款结果通知

支付接口

提供多种支付方式的统一接入接口，支持JSAPI、APP、小程序等支付场景。

统一下单

商户通过调用该接口生成预支付交易单，后续可通过JSAPI调起支付、APP支付等方式完成支付。

POST https://api-test.xinyuepay.com/pay/unifiedorder

请求参数

参数名 类型 是否必填 描述
app_id String 是 商户应用ID
mch_id String 是 商户号
nonce_str String 是 随机字符串，长度32位以内
sign String 是 签名，详见签名算法
body String 是 商品描述
out_trade_no String 是 商户订单号
total_fee Int 是 订单总金额，单位分
spbill_create_ip String 是 终端IP
notify_url String 是 通知地址
trade_type String 是 交易类型，JSAPI/NATIVE/APP
openid String JSAPI时必填 用户openid

响应参数

参数名 类型 描述
return_code String 返回状态码，SUCCESS/FAIL
return_msg String 返回信息
result_code String 业务结果，SUCCESS/FAIL
err_code String 错误码
err_code_des String 错误描述
app_id String 商户应用ID
mch_id String 商户号
nonce_str String 随机字符串
sign String 签名
prepay_id String 预支付交易会话标识
trade_type String 交易类型
code_url String 二维码链接（NATIVE时返回）

请求示例

{
  "app_id": "wx1234567890",
  "mch_id": "1234567890",
  "nonce_str": "abcdefghijklmnopqrstuvwxyz123456",
  "sign": "A1B2C3D4E5F6G7H8I9J0K1L2M3N4O5P6Q7R8S9T0",
  "body": "测试商品",
  "out_trade_no": "202501010000001",
  "total_fee": 100,
  "spbill_create_ip": "127.0.0.1",
  "notify_url": "https://example.com/notify",
  "trade_type": "JSAPI",
  "openid": "oX888888888888888888888"
}

响应示例

{
  "return_code": "SUCCESS",
  "return_msg": "OK",
  "result_code": "SUCCESS",
  "app_id": "wx1234567890",
  "mch_id": "1234567890",
  "nonce_str": "xyz123456abcdefghijklmnopqrstuvw",
  "sign": "Z9Y8X7W6V5U4T3S2R1Q0P9O8N7M6L5K4J3I2H1G0F",
  "prepay_id": "wx202501010000000000000000000000000",
  "trade_type": "JSAPI"
}

接口说明

1. 预支付交易会话标识(prepay_id)有效期为2小时，请及时调用支付接口

2. 调用该接口后，需要根据不同的trade_type调用对应的支付接口完成支付

3. 订单金额total_fee单位为分，请勿传入小数

4. 签名算法请严格按照文档实现，避免因签名错误导致请求失败