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.

统一响应参数

字段是否必选字段类型字段说明
codeString错误码
messageString错误信息
resultBoolean返回结果
dataString业务参数
以下支付,查询,退款,撤销,关闭订单的响应参数为统一响应参数中的业务参数,封装在 data 中。

支付接口

请求地址: https://xlink.91xft.cn/transaction/unify/charge/pay 请求参数
字段是否必选字段类型字段说明
app_idStringapp_id, 由系统统一分配
merchant_codeString商户号
store_codeString门店编号
operator_idString操作员id
limit_payString00-全部 01-限定不能使用信用卡支付 默认值00
out_trade_noString商户订单号
channelString支付渠道
productString支付产品,详细参考附录-支付产品属性值
client_ipString客户端调用的 IP
amountint支付金额,单位分
subjectString订单标题
bodyString商品描述信息
descriptionString订单附加说明
extraString特定支付产品发起交易时额外参数,json字符串
notify_urlString交易的通知地址
callback_urlString收银台支付成功回跳地址
time_startString订单生成时间,yyyyMMddHHmmss
time_expireString订单失效时间,yyyyMMddHHmmss
memoString附加备注
goods_tagString订单优惠标记
detailString微信单品营销用
goods_detailString支付宝商品明细列表
sign_typeString签名类型
signString签名值
响应参数
字段是否必选字段类型字段说明
idString通知支付平台流水号
out_trade_noString商户订单号
stateString订单状态(参考附录-订单状态详情)
credentialString调用支付的凭证
third_trade_noString第三方流水号
channel_trade_noString微信支付宝订单号
failure_codeString业务参数 code
failure_msgString业务结果描述
sign_typeString签名类型
signString签名值

支付凭证 credential 说明

WECHAT_LITE / WECHAT_OFFICE_ACCOUNT
字段字段类型字段说明
appIdString公众号 id
packageValueString订单详情扩展字符串
nonceStrString随机字符串
timeStampString时间戳
paySignString签名值
signTypeString签名类型
WECHAT_H5 / ALIPAY_H5 / BALANCE_PAY: h5_url (String) - 支付跳转链接 WECHAT_APP: prepay_id (String) - 预支付交易会话标识 ALIPAY_FIXED_QRCODE: trade_no (String) - 支付宝返回的售易号 CASHIERPAY: url(收银台地址), form(调起收银台form表单) WECHAT_DYNAMIC_SCAN_CODE / ALIPAY_DYNAMIC_SCAN_CODE: qr_code (String) - 二维码码串 ALIPAY_APP: orderString (String) - 预支付参数 B2B_PAY: form (String) - form 表单 APP_TO_WECHAT_LITE: lite_username, lite_appid, path
系统返回的应答或通知消息可能会由于升级增加参数,请验证通知签名或处理应答报文时注意允许这种情况。

支付接口 V2

请求地址: https://xlink.91xft.cn/transaction/v2/unify/charge/pay 参数及响应与支付接口一致,响应额外返回 payer_id 付款人标识。

定额聚合支付

请求地址: https://xlink.91xft.cn/transaction/unify/charge/qrPrePay 请求参数
字段是否必选字段类型字段说明
app_idStringapp_id
merchant_codeString统一平台分配的商户号
store_codeString门店编号
operator_idString收银员id
out_trade_noString商户系统内部订单号
amountString交易金额,单位分
callback_urlString支付成功前端回调地址
notify_urlString支付成功异步通知地址
attachString订单备注
bodyString商品描述信息
subjectString订单标题
extraString{"qr_code_to_img":"Y"} Y 表示接口返回二维码图片
sign_typeString签名类型
signString签名值
credentialqr_code (String) 二维码码串,qr_code_img_url (String) 图片 url。

订单查询

请求地址: https://xlink.91xft.cn/transaction/unify/charge/query 支付订单和退款订单都用该接口查询。 请求参数app_id, merchant_code, out_trade_no(与 third_trade_no 任一必传), third_trade_no, client_ip, extra, sign_type, sign 响应参数
字段是否必选字段类型字段说明
idString平台流水号
out_trade_noString商户订单号
amountint订单金额(分)
stateString交易状态
payer_idString付款人标识
subjectString订单标题
bodyString商品描述信息
descriptionString订单附加说明
channelString支付渠道
productString支付产品
store_codeString门店编号
operator_idString操作员 id
third_trade_noString第三方流水号
channel_trade_noString微信支付宝订单号
failure_codeString业务参数 code
failure_msgString业务结果描述
sign_typeString签名类型
signString签名值
update_timeString订单完成时间 yyyyMMddHHmmss

申请退款

请求地址: https://xlink.91xft.cn/transaction/unify/charge/refund 请求参数
字段是否必选字段类型字段说明
app_idStringapp_id
merchant_codeString商户
out_trade_noString原交易订单号
third_trade_noString第三方支付流水号
out_refund_noString退款订单号
total_amountint交易金额(分)
refund_amountint退款金额(分)
subjectString商品标题
bodyString商品描述
descriptionString附加说明
extraString预留字段
notify_urlString通知地址
sign_typeString签名类型
signString签名值

撤销交易

请求地址: https://xlink.91xft.cn/transaction/unify/charge/cancel 请求参数: app_id, merchant_code, out_trade_no, third_trade_no(否), out_cancel_no, subject, body, description, extra, sign_type, sign

关闭订单

请求地址: https://xlink.91xft.cn/transaction/unify/charge/close 请求参数: app_id, out_trade_no, merchant_code, subject, body, description, extra, sign_type, sign

订单通知

支付完成后,统一平台系统会把支付结果发送给商户,商户需要接收处理,并返回应答。通知频率为 15/15/30/180/1800/1800/1800/1800/3600,单位:秒。
商户系统对于支付结果通知的内容一定要做签名验证,并校验返回的订单金额是否与商户侧的订单金额一致,防止数据泄漏导致出现“假通知”,造成资金损失。
通知参数不需要加入统一响应参数 data 中。
字段是否必选字段类型字段说明
out_trade_noString商户订单号
createdString订单生成时间 yyyyMMddHHmmss
third_trade_noString第三方流水号
channel_trade_noString微信支付宝订单号
stateString订单状态
merchant_codeString商户编号
update_timeString订单支付时间
amountint订单金额(分)
store_codeString门店编号
operator_idString操作员 id
productString支付产品
client_ipString客户端调用的 IP
subjectString订单标题
bodyString商品描述
descriptionString订单附加说明
payer_idString付款人标识
sign_typeString签名类型
signString签名值
返回:处理成功返回 SUCCESS,不分大小写。

退款订单通知

暂只支持 channel 为 WECHAT / SXF / IPSPAY,其他支付渠道为同步退款或可通过查询接口查询。
字段是否必选字段类型字段说明
out_trade_noString商户订单号(原)
out_refund_noString退款订单号
refund_amountint退款金额(分)
amountint原订单金额(分)
third_refund_noString第三方退款订单号
stateString订单状态
merchant_codeString商户编号
store_codeString门店编号
refund_timeString退款完成时间
productString支付产品
subjectString订单标题
bodyString商品描述
descriptionString订单附加说明
sign_typeString签名类型
signString签名值

下载对账

请求地址: https://xlink.91xft.cn/settle/bill/download/query 请求参数: app_id, merchant_code, sign, sign_type, bill_date(yyyyMMdd), bill_type(1-对账单)。响应返回 bill_download_url

下载渠道对账

请求地址: https://xlink.91xft.cn/settle/bill/agent/download/query 请求参数: app_id, agent_code, sign, sign_type, bill_date, bill_type(1-对账单, 3-结算文件)。响应返回 bill_download_url

下载结算文件

请求地址: https://xlink.91xft.cn/settle/bill/download 请求参数: app_id, merchant_code, sign, sign_type, bill_date。响应返回 bill_download_url

收款设备获取商户支付信息

请求地址: https://xlink.91xft.cn/transaction/device/query/pay/info 请求参数: app_id, device_sn, sign。响应参数包括 md5_key, device_sn, merchant_code, store_code, operator_id, sign, app_id

支付验证码

请求地址: https://xlink.91xft.cn/transaction/unify/charge/sms 请求参数: app_id, sign_type, sign, merchant_code, wc_user_id。响应 check_code 有效期900秒。

当日订单流水

请求地址: https://xlink.91xft.cn/settle/transaction/out/pos/list 请求参数: app_id, sign_type, sign, merchant_code, store_code(否), operator_id(否), limit, offset 响应字段包括:id, createTime, outTradeNo, platTradeNo, thirdTradeNo, merchantFullName, merchantCode, storeFullName, storeCode, operatorId, operatorName, institutionName, productCodeDesc, stateDesc, amount, discountAmount, totalAmount, preRateAmount, channelTradeNo, productCode, institutionCode, refundAmount, state, successTime, tradeDate