Skip to main content

Documentation Index

Fetch the complete documentation index at: https://opendocs.xft.xin/llms.txt

Use this file to discover all available pages before exploring further.

订单状态详情

state详情
00支付成功/退款成功
01支付失败/退款失败
03部分退款
04全部退款
06已撤销
09待支付/待退款
98已关闭

支付产品属性值

product 属性值支付产品名称
WECHAT_OFFICE_ACCOUNT微信公众号支付
WECHAT_DYNAMIC_SCAN_CODE微信扫码支付
WECHAT_SWIPING_CARD微信刷卡支付
WECHAT_LITE微信小程序支付
WECHAT_PARKING微信无感支付
ALIPAY_DYNAMIC_SCAN_CODE支付宝扫码支付
ALIPAY_BAR_CODE支付宝条码支付
ALIPAY_FIXED_QRCODE支付宝固定二维码支付
ALIPAY_H5支付宝 H5 支付
ALIPAY_PARKING支付宝无感支付
ALIPAY_APP支付宝APP支付
FIXED_CODE聚合码支付
AGGREGATION_OFFICE_ACCOUNT聚合公众号支付
PASS_FREE小额免密支付
BAR_CODE条码支付
CMPAY_H5和包H5支付
UNIONPAY_DYNAMIC_SCAN_CODE银联动态扫码支付
UNIONPAY_SWIPING_CARD银联条码支付
WITHHOLD代扣
CASHIERPAY收银台支付
B2B_PAYB2B支付
CARD_PAY卡包支付
WECHAT_LITE_CASHIER小程序收银台
APP_TO_WECHAT_LITEAPP跳微信小程序支付

支付渠道属性值

channel 属性值支付渠道名称
WECHAT微信支付
SPDB浦发支付
HKB汉口支付
SWIFTPASS威富通支付
YS银盛支付
ALIPAY支付宝支付
CCB建行支付
SDP盛付通支付
ICBC工商银行支付
SXF随行付支付
CUP银联支付
CMPAY和包支付
HKBV2汉口2.0
JLPAY嘉联支付
CUPPARK银联金融
TF传化支付
IPSPAY环讯支付
CMB招商银行
CPCN中金支付
UPCARD礼品卡支付

支付 extra 参数说明

特定渠道发起交易时需要的额外参数。

WECHAT_APP

字段是否必选字段类型字段说明
sub_app_idString特约商户在微信开放平台上申请的 APPID

WECHAT_OFFICE_ACCOUNT / WECHAT_LITE

字段是否必选字段类型字段说明
sub_app_idString子商户公众账号 ID
sub_open_idString用户在子商户 appid 下的唯一标识

WECHAT_DYNAMIC_SCAN_CODE

字段是否必选字段类型字段说明
sub_app_idString子商户公众账号 ID
sub_open_idString用户在子商户 appid 下的唯一标识
product_idString二维码中包含的商品 ID

WECHAT_SWIPING_CARD

字段是否必选字段类型字段说明
sub_app_idString子商户公众账号 ID
auth_codeString付款码

WECHAT_H5

字段是否必选字段类型字段说明
sub_app_idString子商户公众账号 ID
sub_open_idString唯一标识
scene_infoString网站应用 h5_info
device_infoStringiOS_SDK/AND_SDK/iOS_WAP/AND_WAP
mch_app_nameString应用名或网站名
mch_app_idString应用唯一标识或网站首页 URL

WECHAT_PARKING

字段是否必选字段类型字段说明
sub_app_idString商户在微信配置的 app_id
scene_infoString无感支付参数 JSON

scene_info 解释(微信无感)

字段是否必选字段类型字段说明
start_timeString进入停车时间
end_timeString出停车场时间
charging_timeString计费时长(秒)
plate_numberString车牌号
car_typeString车辆类型
parking_nameString停车场名称
free_timeString免费时长
contract_idString签约合同编号( channel 为 BCS 时必传)

CASHIERPAY

字段是否必选字段类型字段说明
user_idString用户id(最大长度 20)

ALIPAY_BAR_CODE

字段是否必选字段类型字段说明
auth_codeString付款码

ALIPAY_FIXED_QRCODE

字段是否必选字段类型字段说明
buyer_idString付款人 ID

BAR_CODE

字段是否必选字段类型字段说明
qr_codeString付款码

SIGN_WITHHOLD

字段是否必选字段类型字段说明
agreement_noString预签约返回的签约号
out_agreement_noString预签约上传的外部签约号

ALIPAY_PARKING

字段是否必选字段类型字段说明
scene_infoString停车参数

scene_info 解释(支付宝无感)

字段是否必选字段类型字段说明
start_timeString进入停车时间 yyyyMMddHHmmss
charging_timeString计费时长(秒)
plate_numberString车牌号

PASS_FREE

字段是否必选字段类型字段说明
out_agreement_noString外部签约号
agreement_noString签约号

PASS_FREE / ICBC

字段是否必选字段类型字段说明
msg_idString请求消息标识
notify_urlString签约服务端回调
return_urlString签约前端回调

WITHHOLD

字段是否必选字段类型字段说明
protocal_noString协议编号
user_typeString用户类型(1-对私)
id_typeString证件类型
id_noString证件号码
bank_acct_typeString银行账户类型
bank_acct_noString银行账户编号

CARD_PAY

字段是否必选字段类型字段说明
login_idString登录id
login_id_typeString登录id类型
verify_pay_passwordString是否校验密码 true/false
pay_passwordString支付密码
is_part_consumeString是否支持部分消费 Y/N
sourceString操作渠道
channelString会员渠道

支付 微信 detail 说明

微信商品详情描述,压缩后总长度不能超过 6144 字节。
字段是否必选字段类型字段说明
cost_priceString订单原价
invoice_idString商家小票ID
goods_detailString订单商品明细列表

detail—>goods_detail 说明

字段是否必选字段类型字段说明
merchant_goods_idString商户侧商品编码
wxpay_goods_idString微信支付定义的统一商品编号
goods_nameString商品的实际名称
quantityString用户购买的数量
unit_priceString商品单价(分)
示例:
{
  "merchant_code": "1430100846312",
  "subject": "1",
  "sign": "A50D3E38227F551463D9D0755C4E33SS",
  "description": "test",
  "body": "测试",
  "extra": "{\"auth_code\":\"131486163866088528\"}",
  "client_ip": "192.168.1.1",
  "app_id": "1842479404031148032",
  "sign_type": "MD5",
  "store_code": "",
  "amount": 2000,
  "out_trade_no": "20251210091746379380661",
  "detail": {
    "invoice_id": "1231231233",
    "cost_price": 2000,
    "goods_detail": [
      {
        "wxpay_goods_id": "6907992636306",
        "goods_name": "欣活纵糖奶粉(听装)800g",
        "quantity": 1,
        "merchant_goods_id": "6907992636306",
        "unit_price": 1999
      }
    ]
  }
}

支付 支付宝 goods_detail 说明

字段是否必选字段类型字段说明
goods_idString商品的编号
goods_nameString商品名称
quantityString商品数量
priceString商品单价(元)
out_item_idString商家侧小程序商品ID
out_sku_idString商家侧小程序商品sku ID
alipay_goods_idString支付宝商品统一编号
goods_categoryString商品类目
categories_treeString商品类目树
bodyString商品描述
show_urlString商品展示地址
示例:
{
  "merchant_code": "1350100546109",
  "subject": "1",
  "sign": "56967C1CD8EEF2E4911464743B7765bb",
  "description": "test",
  "body": "测试",
  "extra": "{\"auth_code\":\"280702853407545046\"}",
  "client_ip": "192.168.1.1",
  "app_id": "1525035832283496448",
  "sign_type": "MD5",
  "store_code": "",
  "amount": 300,
  "out_trade_no": "20251210115041920980201",
  "goods_detail": [
    {
      "goods_name": "ipad",
      "alipay_goods_id": "1",
      "quantity": 1,
      "price": "1.0",
      "goods_id": "apple-01",
      "goods_category": "34543238",
      "categories_tree": "124868003|126232002|126252004",
      "body": "特价手机",
      "show_url": "http://www.alipay.com/xxx.jpg"
    }
  ]
}

合单支付参数说明

如果使用了合单支付,订单查询只能通过子订单号查询,退款也只能通过子订单号分开退款。
字段是否必选字段类型字段说明
sub_merchant_codeString合单支付商户号
sub_out_order_noString子订单号
amountString子订单金额(分)
remarkString备注
goods_descString商品描述

小程序跳转易生小程序支付

需要先调预下单接口获取下单地址。
const urlString = decodeURIComponent(url)
const paramsStartIndex = urlString.indexOf('params=');
const paramsString = urlString.slice(paramsStartIndex + 7);
const params = JSON.parse(paramsString);
const path = `pages/index/index?payExpireTime=${params.payExpireTime}&payToken=${params.payToken}&orgTrace=${res.tradeId}`
wx.openEmbeddedMiniProgram({
    appId: 'wxed5226e9688ec728',
    path,
    success() {},
    fail() {}
})

安卓 APP 跳转易生小程序支付

String appId = "wxf3fc08b788503645";
IWXAPI api = WXAPIFactory.createWXAPI(getActivity(), appId);
WXLaunchMiniProgram.Req req = new WXLaunchMiniProgram.Req();
req.userName = "gh_eb36dfa81e82";
req.path = "pages/index/index?payExpireTime=1749540943&payToken=emlRTMeqJpsL80Toc6FD&orgTrace=2025061015254334956045940025";
req.miniprogramType = WXLaunchMiniProgram.Req.MINIPTOGRAM_TYPE_RELEASE;
api.sendReq(req);