对接文档

代付接口 std1

三个接口:提代付、查代付、查余额;代付有结果时我们回调您(见 回调)。都是 POST 表单,应答是一层 JSON。

公共规则

提代付

项目值
方法POST
地址https://api.xx2system.xyz/std1/payout/apply
请求正文application/x-www-form-urlencoded; charset=UTF-8
正文上限65536 字节
限流每秒 20 次
IP 白名单按代付 IP 名单查;名单为空时全部拒绝
应答application/json; charset=UTF-8

请求参数

参数必填规则说明
mchId是格式 [A-Za-z0-9_-]{1,32}商户号
mchOrderNo是格式 [A-Za-z0-9_-]{1,64}您的商户单号,同一商户唯一;结果不明时用它重发(见「同一个商户单号再发一次」)
amount是格式 [1-9][0-9]{0,11}代付金额,整数,按货币最小单位;两位小数的货币 10000 表示 100.00
currency否3 位大写字母,只收本平台币种(CNY);不传就是它币种
accountName是1–64 个字符;首尾不能有空白;不能有控制字符;不能有零宽、双向控制这类看不见的字符收款户名
accountNo是格式 [\x21-\x7E]{5,255}收款账号:银行卡号、钱包账号等,5–255 个可见英文字符(字母、数字、符号),原样收、不去空格、不改大小写
bankName是1–64 个字符;首尾不能有空白开户银行名称(按名字认,不用银行编码)
bankBranch否最多 128 个字符支行
bankProvince否最多 32 个字符开户行所在省
bankCity否最多 32 个字符开户行所在市
notifyUrl否最多 256 个字符;以 http:// / https:// 开头结果回调地址;不传就不回调,您靠查单
remark否最多 128 个字符您自己的备注;查单、回调原样带回,不发给上游
productId否格式 [A-Za-z0-9_-]{1,32}正式产品ID编码请联系客服提供;不传就走您的默认代付产品。传了没开通或已关闭的产品,回 MERCHANT_DISABLED
sign是格式 [0-9A-Fa-f]{64}签名,见「签名」

应答

参数什么时候有说明
code总有(SUCCESS)结果码,见「错误码」
mchId总有商户号
mchOrderNo总有商户单号
payoutNo总有本平台代付单号
amount总有代付金额(最小单位)
fee总有手续费(最小单位),受理时定下
currency总有币种
createTime总有受理时间,北京时间
sign总有签名
msg失败应答里有失败原因(中文,给人看)

同一个商户单号再发一次

这个单号这次的参数您收到
已受理和第一次完全相同和第一次逐字节相同的受理应答,不会再出一笔
已被拒和第一次完全相同和第一次相同的拒绝应答
已受理或已被拒有任何不同ORDER_NO_CONFLICT:这次没执行,原单不受影响
没有记录—当新请求处理

示例

示例密钥(假的):0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef;示例商户号:DEMO0001

POST https://api.xx2system.xyz/std1/payout/apply

签名串

accountName=张三&accountNo=6222021234567890123&amount=10000&bankName=中国工商银行&mchId=DEMO0001&mchOrderNo=ORDER-20260917-0001

sign

4d368047ec349d118d7865c7bcba91f1f152c72b41bba9f389be963630a22064

请求正文

accountName=%E5%BC%A0%E4%B8%89&accountNo=6222021234567890123&amount=10000&bankName=%E4%B8%AD%E5%9B%BD%E5%B7%A5%E5%95%86%E9%93%B6%E8%A1%8C&mchId=DEMO0001&mchOrderNo=ORDER-20260917-0001&sign=4d368047ec349d118d7865c7bcba91f1f152c72b41bba9f389be963630a22064

应答(受理:钱已冻结,不是已出款)

{"code":"SUCCESS","mchId":"DEMO0001","mchOrderNo":"ORDER-20260917-0001","payoutNo":"P20260917120000000001","amount":"10000","fee":"200","currency":"CNY","createTime":"2026-09-17 12:00:00","sign":"13dc9a6b36d02a8dc8fe08117a4b85cdf9e69d3bc50cc7c5010df98263d809e0"}

应答(被拒(B 类):订单已拒绝(终态),商户订单号已占用)

{"code":"INSUFFICIENT_BALANCE","msg":"可用余额不足","mchId":"DEMO0001","mchOrderNo":"ORDER-20260917-0001","sign":"9213d0f28d29dd694bf15c5797c985a3926a059157dfefaa81f71aae57c52331"}

查代付

项目值
方法POST
地址https://api.xx2system.xyz/std1/payout/query
请求正文application/x-www-form-urlencoded; charset=UTF-8
正文上限65536 字节
限流每秒 50 次
IP 白名单按代付 IP 名单查;名单为空时全部拒绝
应答application/json; charset=UTF-8

请求参数

参数必填规则说明
mchId是格式 [A-Za-z0-9_-]{1,32}商户号
mchOrderNo二选一格式 [A-Za-z0-9_-]{1,64}您的商户单号,同一商户唯一;结果不明时用它重发(见「同一个商户单号再发一次」)
payoutNo二选一格式 [A-Za-z0-9]{1,32}本平台代付单号(受理应答里给的)
sign是格式 [0-9A-Fa-f]{64}签名,见「签名」

mchOrderNo、payoutNo 至少给一个;两个都给时必须是同一笔,否则回 ORDER_NOT_FOUND。

应答

参数什么时候有说明
code总有(SUCCESS)结果码,见「错误码」
mchId总有商户号
mchOrderNo总有商户单号
payoutNo总有本平台代付单号
amount总有代付金额(最小单位)
fee总有手续费(最小单位),受理时定下
currency总有币种
status总有代付状态,见下面「状态」
createTime总有受理时间,北京时间
finishTimestatus 是 FAILED / REVERSED / SUCCESS 时有进入当前状态的时间
failMsgstatus 是 FAILED 时有撤单原因
remark总有申请时的备注
sign总有签名
msg失败应答里有失败原因(中文,给人看)

状态

状态意思
PROCESSING处理中:已受理,钱冻着,还没有最终结果。可能持续几小时到几天,不会重复出款
SUCCESS已出款
FAILED已撤单,钱已退回可用余额
REVERSED出款后被退回(冲正),钱已退回

示例

示例密钥(假的):0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef;示例商户号:DEMO0001

POST https://api.xx2system.xyz/std1/payout/query

签名串

mchId=DEMO0001&mchOrderNo=ORDER-20260917-0001

sign

20f17f6d87cf293d6ced8c01c4c40d887d7846161e306d7610828fe333c83b25

请求正文

mchId=DEMO0001&mchOrderNo=ORDER-20260917-0001&sign=20f17f6d87cf293d6ced8c01c4c40d887d7846161e306d7610828fe333c83b25

应答(已出款)

{"code":"SUCCESS","mchId":"DEMO0001","mchOrderNo":"ORDER-20260917-0001","payoutNo":"P20260917120000000001","amount":"10000","fee":"200","currency":"CNY","status":"SUCCESS","createTime":"2026-09-17 12:00:00","finishTime":"2026-09-17 12:05:30","sign":"6d415f531376788d1e915e70deeffb44e96f669aba651f32e33933255f650fa2"}

查余额

项目值
方法POST
地址https://api.xx2system.xyz/std1/balance/query
请求正文application/x-www-form-urlencoded; charset=UTF-8
正文上限65536 字节
限流每秒 10 次
IP 白名单按代付 IP 名单查;名单为空时全部拒绝
应答application/json; charset=UTF-8

请求参数

参数必填规则说明
mchId是格式 [A-Za-z0-9_-]{1,32}商户号
currency否3 位大写字母,只收本平台币种(CNY);不传就是它币种
sign是格式 [0-9A-Fa-f]{64}签名,见「签名」

应答

参数什么时候有说明
code总有(SUCCESS)结果码,见「错误码」
mchId总有商户号
currency总有币种
balance总有总余额(最小单位),含冻结中的
frozenAmount总有冻结中(最小单位):在途代付、结算申请冻着的钱
availableAmount总有可用余额(最小单位)=总余额-冻结中
sign总有签名
msg失败应答里有失败原因(中文,给人看)

availableAmount=balance-frozenAmount。开了「允许负余额」的商户,余额可能是负数。

示例

示例密钥(假的):0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef;示例商户号:DEMO0001

POST https://api.xx2system.xyz/std1/balance/query

签名串

mchId=DEMO0001

sign

a896e78745bd80092e80a28976a4f758ca0a713d74228db79806337828fd9695

请求正文

mchId=DEMO0001&sign=a896e78745bd80092e80a28976a4f758ca0a713d74228db79806337828fd9695

应答(查余额)

{"code":"SUCCESS","mchId":"DEMO0001","currency":"CNY","balance":"500000","frozenAmount":"10200","availableAmount":"489800","sign":"0b6b91b47831daa89b4c350a6eb38b755d998df8fc168e503b68bacfa5b634fd"}