测试地址:http://116.228.64.55:28082/yst-service-api/tq/handle
生产地址:https://ibsapi.allinpay.com/yst-service-api/tq/handle
接口代码(transCode):4004
功能说明:
中信托管:
- 此接口支持“601-中信银行订单清分文件”文件上传、“801-中信银行订单清分文件处理结果文件”下载、以及文件处理状态查询。
- 文件命名:云商通应用号+平台商户编号(15,说明:银行分配)+渠道编号(4位,说明:银行提供)+文件类型(3位,如601/801)+日期(8位, T+1来账,日期上送T日)+序号(2位,默认01)+.txt(4位后缀)。
- 说明:按照渠道实际到账日期的前一天为文件日期上传清分文件,比如4月4/5/6号的交易,同一个渠道可以放在一份文件里,文件名称的日期上送“6号”,则7号上传文件。
- “601-中信银行订单清分文件”内容格式:文件每行一条记录,字段间使用0x03(ASCII的03)分隔符,换行使用‘\n’,UTF-8编码。文件中所有金额字段,包括原始订单金额、原始支付金额、平台优惠金额、平台分成金额、平台垫款金额、渠道手续费,均不可为负数,以元为单位,小数点后最多两位,不包含任何符号。
- “601-中信银行订单清分文件”校验:平台商户需在支付渠道资金结算至中信银行后,上传“601-中信银行订单清分文件”文件。该文件提供通联支付渠道进行清算的用户交易明细,通联进行结算资金和账务核对一致后,请求中信银行,银行校验文件有效性后,在下一个最近的清分时间点且资金已到账,核对资金一致性(允许一定阈值),并将交易资金账户收到的支付渠道清算资金清分至各交易用户银行子账户;清分文件处理时间40分钟左右,清分文件处理时,可查询文件处理状态,并下载清分文件明细处理结果文件。
- 同名文件仅可以上传一次,序号不可变;根据如下文件状态,该接口支持文件处理失败后重传。
- 文件状态处理说明:
601文件状态 |
处理说明 |
是否允许重新上传文件 |
0-银行文件上传成功 7-文件合法性检查通过 9-清分处理完成 X6-待核对通联结算资金 X5-待上传银行 X7- 待解析文件 |
说明601文件再处理中,因银行一般在40分钟内处理完成,建议商户可1个小时后轮询机制主动查询文件状态; |
不允许重新上传 |
AA-结果文件生成成功 |
可以申请下载801文件 |
不允许重新上传 |
B-支付渠道未来账 |
终态 |
不允许重新上传 |
2-异常长短款 |
①联系分行经办人进行勾销处理。勾销后,渠道来账差额资金从平台商户自有资金登记簿扣划,文件继续进行清分。 方式 ②联系分行经办人进行另行核对处理,即当前文件作废,重新上传文件进行清分。 |
需要分行处理成“4-已另行核对”,再重新上传文件 |
Q-一般为自有资金账户余额不足或服务内部错误 |
联系分行业务另行核对,重新上传文件,若不修改文件,请给自有资金实体账户充值 |
需要分行处理成“4-已另行核对”,再重新上传文件 |
Q3-用户登记簿余额不足,暂停清分 |
联系分行业务另行核对,重新上传文件,若不修改文件,请给用户登记簿充值 |
需要分行处理成“4-已另行核对”,再重新上传文件 |
4-已另行核对 8-文件合法性检查不通过 X1-通联支付渠道结算资金核对不一致 X2=未成功获取通联支付渠道结算单 X3-文件名称不正确 X4-文件明细字段校验不通过 X8- 文件解析异常 X9-上传银行失败 X10-商户上传文件下载失败 |
/ |
支持重新上传文件 |
- 当601文件的文件状态= AA-结果文件生成成功,可下载801文件查看处理结果。
华通托管:
- 此接口支持“602-华通支付交易流水文件、603-华通清算分账文件”文件上传、“802-华通支付交易流水文件上送结果文件、803-华通清分分账文件处理结果文件”下载、以及文件处理状态查询。
- 文件命名:文件名称格式:云商通应用号+平台商户编号+文件类型(3位,默认602、603、802、803)+日期(8位,T+1来账,日期上送T日)+序号(2位,默认01)+.txt(4位后缀)。
- 内容格式:使用|对每个字段进行分割,空值不忽略。同批次内最大笔数限制1000笔。
- 接收到【划款入账通知】,才可上传“清算分账文件”,在上传“清算分账文件”之前,先上传“支付交易流水文件”。默认同一支付流水仅支持被关联至多5个分账流水,若业务需求超过5个则需要申请后管配置调整。支持结算入金资金被多次清分。
- 文件状态说明:
602/603文件状态
是否允许重新上传文件
X3-文件名称不正确
X4-文件明细字段校验不通过
X8- 文件解析异常
X9-上传银行失败
X10-商户上传文件下载失败
支持重新上传文件
文件下载文件状态说明:
801/802/803文件状态 |
接口响应信息 |
D1-待向银行下载 |
接口响应“待向银行下载文件!”。 |
D2-银行文件下载失败 |
接口响应“银行文件下载失败,不支持下载商户文件!”。 |
D7-商户文件生成失败 |
接口 “商户文件生成失败,不支持下载!”。 |
D6-商户文件生成成功 |
下载成功,接口返回801文件 |
D5-待生成商户文件 D0-银行文件下载成功 |
则接口响应“文件处理中,请稍后下载!”。 |
无文件记录 |
接口响应“文件暂未生成,请稍后下载!”。 |
文件示例:
601文件示例:
文件名称:21751798293115834370J0401990000000010026012024042301 :https://kdocs.cn/l/cbqZxNGXWr9Q
801文件示例:
文件名称: 21751798293115834370J0401990000000010038012024042201:https://kdocs.cn/l/cjR5vWPj5CMt
业务请求参数
字段 |
字段类型 |
必填 |
字段名称 |
说明 |
reqTraceNum |
String |
是 |
请求流水号 |
全局唯一,不可重复 不可包含“|”字符 |
fileOptType |
String |
是 |
操作类型 |
01:上传 说明:上传仅针对“601”、602、603”文件 02:下载 说明:下载仅针对“801”、802、803”文件 03:查询文件状态 仅支持查询“601、602、603”文件状态 |
fileType |
String |
是 |
文件类型 |
文件类型: 601-中信银行订单清分文件 801-中信银行订单清分文件处理结果文件 602-华通支付交易流水文件 603-华通清分分账文件 802-华通支付交易流水文件上送结果文件 803-华通清分分账文件处理结果文件 |
token |
String |
否 |
文件token |
通过【文件上传下载】接口上传文件后获取的fileId,有效期30分钟 仅上传601、602、603文件,上送 |
fileName |
String |
是 |
文件名称 |
03:查询文件状态 仅,601、602、603文件必填 02:下载 必填 01:上传 必填 |
业务响应参数
字段 |
字段类型 |
字段长度 |
必填 |
字段名称 |
说明 |
respTraceNum |
String |
否 |
响应流水号 |
业务正常处理,则返回 |
|
respCode |
String |
是 |
业务返回码 |
00000:代表受理成功 66666、66667:处理中,即当前的请求已受理,需要继续调用关联的确认类接口,或通过发起订单查询、等待异步通知,来获取处理状态。 其他返回码:均代表失败 |
|
respMsg |
String |
是 |
错误信息 |
上传失败时返回 (1)文件合法性校验不通过时,描述具体原因。 如:结果描述|长短款金额|支付渠道编号|明细条数|应入账金额|实际入账金额 (2)文件明细字段校验不通过,描述具体原因。 如:原订单金额为空 (3)通联支付渠道结算资金核对不一致,描述具体原因 如:通联结算资金合计=6789,文件明细资金合计=1223 |
|
fileState |
String |
否 |
文件状态 |
0-银行文件上传成功 2-异常长短款 4-已另行核对 B-支付渠道未来账 AA-结果文件生成成功 Q3-用户登记簿余额不足,暂停清分 X1-通联支付渠道结算资金核对不一致 X2-未成功获取通联支付渠道结算单 X3-文件名称不正确 X4-文件明细字段校验不通过 X5-待上传银行 X6-待核对通联结算资金 X7- 文件已受理,待处理 X8- 文件解析异常 X9-上传银行失败 X10-商户上传文件下载失败 801文件状态: D1-待向银行下载 D0-银行文件下载成功 D2-银行文件下载失败 D5-待生成商户文件 D7-商户文件生成失败 D6-商户文件生成成功 D3-商户文件下载成功 D4-商户文件下载失败 |
|
file |
String |
否 |
下载文件 |
仅下载801文件返回 文件经base64编码后的字符串 |
601文件内容字段:
序号 |
字段名称 |
长度 |
说明 |
字段校验说明 |
1 |
云商通应用编号 |
String(100) |
云商通分配商户的应用编号 |
不能为空。 |
2 |
通联结算商户号 |
String(64) |
该笔支付订单在支付渠道侧最终结算至中信银行的结算商户号 |
通联支付渠道,不能为空。 |
3 |
通联交易商户号 |
String(64) |
该笔支付订单在支付渠道侧的交易商户号 |
通联支付渠道,不能为空。 |
4 |
平台商户编号 |
String(15) |
银行系统给平台商户分配的唯一识别号,以银行客户经理通知为准 |
不能为空。 |
5 |
银行用户编号 |
String(100) |
银行系统给用户分配的唯一识别号 |
不能为空,且在【银行子账户信息管理】菜单存在。 |
6 |
交易日期 |
String(8) |
明细交易日期,以平台商户记录的日期为准 |
不能为空,格式:yyyyMMdd。 |
7 |
交易时间 |
String(6) |
明细交易时间,以平台商户记录的时间为准 |
不能为空,格式:HHMMSS。 |
8 |
支付渠道名称 |
String(60) |
按照参数设置约定,以银行客户经理通知为准 1014:通联支付 1071:抖音 1050:美团 1002:支付宝 1003:微信 |
不能为空。 |
9 |
平台商户业务订单号 |
String(64) |
该笔业务订单由平台商户端生成的唯一标识 |
不能为空。 |
10 |
平台商户支付订单号 |
String(64) |
该笔支付订单由平台商户端生成的唯一标识 |
不能为空。 |
11 |
支付渠道交易流水号 |
String(64) |
该笔支付订单由支付渠道方生成的唯一标识。 当平台商户开通业务订单明细对账功能时,为收单商户号+分隔符1位(字符’|’)+该笔支付订单由支付渠道方生成的唯一标识. 当平台商户未开通业务订单明细对账功能时,该笔支付订单由支付渠道方生成的唯一标识. |
允许多个业务订单对应一张支付订单,不能为空。 |
12 |
平台商户业务子订单号 |
String(64) |
该笔业务订单下每笔业务子订单由平台商户端生成的唯一标识,需保证平台商户业务订单号+平台商户业务子订单号保证唯一,允许多个业务子订单对应一张业务订单。 |
不能为空。 |
13 |
支付订单交易类型 |
String(2) |
1-支付 |
1、支付订单交易类型为“支付”时,业务订单交易类型应为“实时交易支付” |
14 |
业务订单交易类型 |
String(2) |
1 -实时交易支付 |
1、实时交易:买方与卖方确定,资金链路与业务链路完整,交易可完成; |
15 |
清算资金来源 |
String(1) |
1-支付渠道 |
1、支付渠道:通过支付渠道来账; |
16 |
渠道手续费承担方式 |
String(1) |
若平台商户承担,且支付渠道清算方式为轧差清算,则系统会将渠道手续费金额从平台商户自有资金登记簿扣减后,与支付渠道结算资金一并清分至用户; |
|
17 |
原订单金额 |
Decimal(15,2) |
该笔业务子订单的原始成交金额,元为单位 |
平台展示价格,原始订单金额=平台优惠金额+原始支付金额 |
18 |
原支付金额 |
Decimal(15,2) |
该笔业务子订单对应的原始支付/退款金额, 元为单位 |
买家实际支付金额 |
19 |
平台优惠金额 |
Decimal(15,2) |
该笔业务子订单对应的平台优惠补贴金额, 元为单位。 平台商户给买家客户的优惠补贴,清算时将对应的优惠金额从平台自有资金登记簿扣除清分至用户。 |
该字段不能为负数,须小于等于原始订单金额。 |
20 |
平台分成金额 |
Decimal(15,2) |
该笔业务子订单对应的平台应分成金额, 元为单位。 平台商户从交易中抽取的佣金,清分核算完成后转至平台自有资金登记簿 |
该字段不能为负数,须小于等于原始订单金额 |
21 |
平台垫款金额 |
Decimal(15,2) |
如该用户交易当日存在超额提现,则平台商户应在此处自行填写垫款回收金额, 元为单位 |
此字段应用于超额提现功能,暂未实现,赋值0 |
22 |
渠道手续费 |
Decimal(15,2) |
元为单位 如支付渠道清算方式为轧差清算,则支付渠道打款金额应等于原始支付金额合计-渠道手续费合计 |
支付渠道根据交易收取的支付手续费 |
23 |
资金类型 |
String(6) |
以银行客户经理通知为准 |
|
24 |
备注 |
String(200) |
|
801文件内容字段:
序号 |
字段名称 |
长度 |
说明 |
1 |
云商通应用编号 |
String(100) |
同601文件 |
2 |
通联结算商户号 |
String(64) |
同601文件 |
3 |
通联交易商户号 |
String(64) |
同601文件 |
4 |
平台商户编号 |
String(15) |
同601文件 |
5 |
银行用户编号 |
String(100) |
同601文件 |
6 |
交易日期 |
String(8) |
同601文件 |
7 |
交易时间 |
String(6) |
同601文件 |
8 |
支付渠道名称 |
String(60) |
同601文件 |
9 |
平台商户业务订单号 |
String(64) |
同601文件 |
10 |
平台商户支付订单号 |
String(64) |
同601文件 |
11 |
通联交易商户号 |
String(64) |
同601文件 |
12 |
支付渠道交易流水号 |
String(64) |
同601文件 |
13 |
平台商户业务子订单号 |
String(64) |
同601文件 |
14 |
支付订单交易类型 |
String(2) |
同601文件 |
15 |
业务订单交易类型 |
String(2) |
同601文件 |
16 |
清算资金来源 |
String(1) |
同601文件 |
17 |
渠道手续费承担方式 |
String(1) |
同601文件 |
18 |
原订单金额 |
Decimal(15,2) |
同601文件 |
19 |
原支付金额 |
Decimal(15,2) |
同601文件 |
20 |
平台优惠金额 |
Decimal(15,2) |
同601文件 |
21 |
平台分成金额 |
Decimal(15,2) |
同601文件 |
22 |
平台垫款金额 |
Decimal(15,2) |
同601文件 |
23 |
渠道轧差手续费 |
Decimal(15,2) |
同601文件 |
24 |
资金类型 |
String(6) |
同601文件 |
25 |
备注 |
String(200) |
同601文件 |
26 |
处理结果 |
String(7) |
AAAAA:表示成功 |
27 |
处理描述 |
String(100) |
系统返回描述信息 |
602文件内容字段:
文件头:
文件头H |
数据类型 |
长度 |
名称 |
备注 |
必输 |
headMark |
String |
1 |
文件头标志位 |
固定值:H |
Y |
txType |
String |
50 |
业务类型 |
标志文件类型 pay_flow |
Y |
transDate |
String |
8 |
交易日期 |
格式:yyyyMMdd |
Y |
rowCount |
String |
10 |
总行数 |
数据行行数 |
Y |
ystId |
String |
100 |
云商通应用号 |
|
Y |
文件体:
属性 |
长度 |
是否必要 |
描述 |
交易日期 |
8 |
M |
格式为yyyyMMdd |
交易时间 |
6 |
M |
HHmmss |
支付订单号 |
32 |
M |
唯一性校验 平台订单号 |
交易商户号 |
32 |
M |
交易商户号 |
交易金额 |
15 |
M |
单位:分 无小数点 |
支付方式 |
2 |
M |
0支付宝 1微信 2银联 3无正向支付流水 9其他支付方式 |
交易商户/卖方名称 |
100 |
M |
卖方名称填写实际卖家名称 |
付款方/买方名称 |
100 |
M |
买方名称可以填写姓名,昵称,微信openid,支付宝id,银行卡号(中间位隐藏)。付款方id可以填写微信openid,支付宝id,银行卡号(中间位隐藏),在有买方名称的情况下,付款方id可以是平台本身的ID |
商品信息(描述) |
512 |
M |
支付方式为3时,该字段传对应的分账协议编号 |
备注说明 |
1024 |
O |
支付方式为3时,该字段传对应的分账协议内容上传至SFTP服务器路径,支持PDF;
客户需先通过行内开通的SFTP把协议文件上传至指定的服务器,并在本字段上送分账协议PDF上传的服务器完整路径(包含文件名) |
商户手机号码 |
20 |
O |
|
支付机构编码 |
10 |
M |
|
交易渠道支付订单号 |
50 |
M |
指收单机构生成订单号 |
付款方/买方Id |
50 |
M |
|
付款方手机号码 |
20 |
O |
|
优惠金额 |
15 |
O |
单位:分 无小数点 |
物流信息 |
200 |
O |
|
603文件内容字段:
文件头:
文件头H |
数据类型 |
长度 |
名称 |
备注 |
必输 |
headMark |
String |
1 |
文件头标志位 |
固定值:H |
Y |
txType |
String |
50 |
业务类型 |
标志文件类型,settle |
Y |
settleDate |
String |
8 |
交易日期 |
格式:yyyyMMdd |
Y |
rowCount |
String |
10 |
总行数 |
数据行行数 |
Y |
ystId |
String |
100 |
云商通应用号 |
|
Y |
文件体:
属性 |
长度 |
是否必要 |
描述 |
清算日期 |
|
M |
格式为yyyyMMdd |
客户端流水号 |
|
M |
客户端流水唯一 |
用户账号 |
|
M |
开户时创建 |
金额 |
|
M |
单位:分 无小数点 |
结算方式 |
|
M |
1=记账结算 |
账期 |
|
M |
账期为0,实时清分 |
备注信息 |
|
O |
|
交易订单号列表 |
|
M |
多个用逗号隔开 说明:上送支付交易流水文件里面的“支付订单号”字段 |
交易订单号列表分别对应的参与分账金额 |
|
M |
(1)多个用逗号隔开且值必须为数字,逗号“,”分割后个数必须与“交易订单号列表”个数一致 (1) 分账金额总额要小于或等于“金额”字段 (2) 同一支付流水仅支持被关联至多5个分账流水 |
扩展字段3 |
|
O |
|
802文件内容字段:
文件头:
属性名称 |
中文名称 |
长度 |
请求 |
应签 |
描述 |
ystId |
云商通应用号 |
varchar(50) |
|
M |
应用号 |
industryCode |
客户号 |
varchar(32) |
|
M |
客户号 |
batchNo |
批次号 |
varchar(30) |
|
M |
原支付流水上送批次号 |
batchStatus |
批次状态 |
varchar(2) |
|
M |
详见5.23 仅会0或1 |
文件体:
属性名称 |
中文名称 |
长度 |
请求 |
应签 |
描述 |
reqDate |
请求日期 |
Varchar(8) |
|
M |
请求日期yyyyMMdd |
reqTime |
请求时间 |
Varcahr(6) |
|
M
|
请求时间HHmmss |
transDate |
交易日期 |
Varchar(8) |
|
M |
交易日期yyyyMMdd |
transTime |
交易时间 |
Varcahr(6) |
|
M
|
交易时间HHmmss |
transOrderId |
交易支付订单号 |
Varcahr(64) |
|
M |
交易支付订单号 |
merNo |
交易商户号 |
varchar(32) |
|
O |
交易商户号 |
pay_mode |
支付方式 |
varchar(2) |
|
M |
0支付宝 1微信 2银联 3无正向支付流水 9其他支付方式 |
transAmount |
交易金额单位分 |
long |
|
M |
|
sellerName |
卖方名称 |
varchar(200) |
|
M |
|
buyerName |
买方名称 |
varchar(202) |
|
O |
|
goodsInfo |
商品信息 |
varchar(1024) |
|
M |
|
uploadStatus |
上送状态 |
varchar(10) |
|
M |
成功:SUCCESS | 失败:FAILURE' |
uploadDesc |
上送状态描述 |
varchar(1024) |
|
M |
上送状态描述 |
803文件内容字段:
文件头:
文件头H |
数据类型 |
长度 |
名称 |
备注 |
必输 |
headMark |
String |
1 |
文件头标志位 |
固定值:H |
Y |
txType |
String |
50 |
业务类型 |
标志文件类型,settle_result |
Y |
settleDate |
String |
8 |
日期 |
格式:yyyyMMdd |
Y |
rowCount |
String |
10 |
总行数 |
数据行行数 |
Y |
ystId |
String |
50 |
云商通应用号 |
|
Y |
文件体:
属性 |
长度 |
是否必要 |
描述 |
清算日期 |
|
M |
格式为yyyyMMdd |
客户端流水号 |
|
M |
客户端流水唯一 |
用户账号 |
|
M |
开户时创建 |
金额 |
|
M |
单位:分 无小数点 |
结算方式 |
|
M |
1=记账结算 |
账期 |
|
M |
账期为0,实时清分 |
备注信息 |
|
O |
|
扩展字段1 |
|
M |
订单流水列表 |
扩展字段2 |
|
O |
服务端流水号唯一 |
扩展字段3 |
|
O |
|
交易状态 |
|
M |
详见交易状态 PRE_CREATE-创建订单 PROCESSING-处理中 TRADE_SUCCESS-交易明确成功 TRADE_FAILURE-交易明确失败 TRADE_ERROR-交易错误或不明确状态 |
结果说明 |
|
O |
|
对账日期 |
|
O |
|