麒麟云服开放平台

麒麟云服开放平台接口


单笔转账

<h3>接口功能</h3> <p>发起单笔转账。</p> <h3>流程图</h3> <p><img src="https://www.showdoc.com.cn/server/api/attachment/visitFile?sign=3b856952bb2c62c149dff499abb3e3b5&amp;amp;file=file.jpg" alt="" /></p> <h3>请求URL</h3> <ul> <li><code>api/kycloud/open/v1.0/transfer</code></li> </ul> <h3>请求方式</h3> <ul> <li>POST</li> </ul> <h3>公共请求参数</h3> <table> <thead> <tr> <th>参数名称</th> <th>类型</th> <th>是否必填</th> <th>最大长度</th> <th>参数描述</th> <th>示例值</th> </tr> </thead> <tbody> <tr> <td>companyId</td> <td>数值</td> <td>是</td> <td>11</td> <td>平台分配给企业的ID</td> <td>52984126340489216</td> </tr> <tr> <td>charset</td> <td>字符</td> <td>是</td> <td>10</td> <td>请求使用的编码格式,如utf-8,gbk等</td> <td>utf-8</td> </tr> <tr> <td>signType</td> <td>字符</td> <td>是</td> <td>10</td> <td>企业生成签名字符串所使用的签名算法类型,目前支持RSA和RSA2,推荐使用RSA2</td> <td>RSA2</td> </tr> <tr> <td>bizContent</td> <td>json</td> <td>是</td> <td>不限</td> <td>请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递</td> <td>-</td> </tr> <tr> <td>timestamp</td> <td>字符</td> <td>是</td> <td>19</td> <td>发送请求的时间,格式&quot;yyyy-MM-dd HH:mm:ss&quot;</td> <td>2023-10-01 08:08:08</td> </tr> <tr> <td>sign</td> <td>字符</td> <td>是</td> <td>344</td> <td>企业请求参数的签名串,详见[数据签名](<a href="https://www.showdoc.com.cn/kycloudopen/11199716093743187">https://www.showdoc.com.cn/kycloudopen/11199716093743187</a> &quot;数据签名&quot;)</td> <td>详见示例</td> </tr> </tbody> </table> <h3>请求参数</h3> <table> <thead> <tr> <th>参数名称</th> <th>类型</th> <th>是否必填</th> <th>最大长度</th> <th>参数描述</th> <th>示例值</th> </tr> </thead> <tbody> <tr> <td>outBizNo</td> <td>字符</td> <td>是</td> <td>50</td> <td>企业唯一订单号,由企业自定义</td> <td>2023100080808</td> </tr> <tr> <td>accountId</td> <td>数值</td> <td>否</td> <td>11</td> <td>资金账户ID,有值则从此账户出款,否则从默认资金账户出款</td> <td>10002</td> </tr> <tr> <td>businessId</td> <td>数值</td> <td>否</td> <td>11</td> <td>平台分配给企业的业务ID</td> <td>52984126340489216</td> </tr> <tr> <td>accountType</td> <td>字符</td> <td>是</td> <td>20</td> <td>收款方账户类型,银行卡BANK_ACCOUNT、支付宝ALI_ACCOUNT、微信WX_ACCOUNT</td> <td>ALI_ACCOUNT</td> </tr> <tr> <td>accountNo</td> <td>字符</td> <td>是</td> <td>50</td> <td>收款方账号</td> <td>testaccount@alipay.com</td> </tr> <tr> <td>name</td> <td>字符</td> <td>是</td> <td>20</td> <td>收款方真实姓名,如果非空,将校验收款账号与姓名一致性</td> <td>张三</td> </tr> <tr> <td>phone</td> <td>字符</td> <td>是</td> <td>11</td> <td>收款方手机号码</td> <td>13100000000</td> </tr> <tr> <td>idCardNo</td> <td>字符</td> <td>是</td> <td>18</td> <td>收款方身份证号码</td> <td>33010120231001111</td> </tr> <tr> <td>transAmount</td> <td>数值</td> <td>是</td> <td>20</td> <td>订单金额,单位元,精确到小数点后两位(最低金额0.1元)</td> <td>10.01</td> </tr> <tr> <td>notifyUrl</td> <td>字符</td> <td>否</td> <td>128</td> <td>回调地址</td> <td><a href="https://www.baidu.com/callback">https://www.baidu.com/callback</a></td> </tr> <tr> <td>voucherNotifyUrl</td> <td>字符</td> <td>否</td> <td>128</td> <td>回执单回调地址</td> <td><a href="https://www.baidu.com/callback">https://www.baidu.com/callback</a></td> </tr> <tr> <td>remark</td> <td>字符</td> <td>否</td> <td>50</td> <td>备注</td> <td>服务费</td> </tr> </tbody> </table> <h3>公共响应参数</h3> <table> <thead> <tr> <th>参数名称</th> <th>类型</th> <th>是否必填</th> <th>最大长度</th> <th>参数描述</th> <th>示例值</th> </tr> </thead> <tbody> <tr> <td>code</td> <td>字符</td> <td>否</td> <td>-</td> <td>错误码</td> <td>open_request_expired</td> </tr> <tr> <td>success</td> <td>字符</td> <td>是</td> <td>-</td> <td>请求是否成功,成功true、失败false</td> <td>true</td> </tr> <tr> <td>message</td> <td>字符</td> <td>否</td> <td>-</td> <td>失败描述</td> <td>请求过期,请求重新发起</td> </tr> <tr> <td>object</td> <td>json</td> <td>是</td> <td>-</td> <td>请求成功后,平台响应数据</td> <td>{&quot;orderId&quot;:&quot;52984126340489216&quot;}</td> </tr> </tbody> </table> <h3>响应参数</h3> <table> <thead> <tr> <th>参数名称</th> <th>类型</th> <th>是否必填</th> <th>最大长度</th> <th>参数描述</th> <th>示例值</th> </tr> </thead> <tbody> <tr> <td>orderId</td> <td>字符</td> <td>是</td> <td>-</td> <td>平台订单ID</td> <td>52984126340489216</td> </tr> </tbody> </table> <h3>错误码</h3> <table> <thead> <tr> <th>错误码</th> <th>错误描述</th> </tr> </thead> <tbody> <tr> <td>open_out_biz_no_repeat</td> <td>企业订单号重复</td> </tr> <tr> <td>open_system_error</td> <td>系统错误,请联系平台处理</td> </tr> <tr> <td>open_system_busy</td> <td>系统繁忙(可能发生了网络或者系统异常,导致无法判定准确的转账结果。此时,商户不能直接当做转账成功或者失败处理,可以考虑采用相同的outBizNo重发请求,或者通过调用“单笔转账查询接口”来查询该笔转账订单的最终状态。)</td> </tr> <tr> <td>open_no_signed_supplier</td> <td>企业没有签约供应商</td> </tr> <tr> <td>open_supplier_channel_not_match_account_type</td> <td>收款方账户类型与签约供应商支付通道不匹配</td> </tr> <tr> <td>open_fund_account_not_existed</td> <td>企业资金账户不存在</td> </tr> <tr> <td>open_task_not_existed</td> <td>企业没有可用的任务</td> </tr> <tr> <td>open_settle_rule_setting_error</td> <td>服务费结算规则没有配置或者配置错误</td> </tr> <tr> <td>open_account_amount_not_enough</td> <td>账户余额不足,请充值后操作</td> </tr> <tr> <td>open_user_not_auth_error</td> <td>用户未实名</td> </tr> <tr> <td>open_illegal_age</td> <td>收款人年龄不能小于16周岁</td> </tr> <tr> <td>open_illegal_user</td> <td>收款人不能是企业法人、股东、监事</td> </tr> <tr> <td>open_user_withdraw_limit</td> <td>提现受限,同一个人的提现操作请间隔5秒以上</td> </tr> </tbody> </table> <h2>单笔转账回调</h2> <h3>请求方式</h3> <ul> <li>POST</li> </ul> <p>企业发起转账请求,等待支付完成后,平台进行回调通知。针对回调code不为200或http请求超时,会发起重试,重试5次。</p> <p>企业接收回调后返回报文例子(报文格式 application/json;charset=UTF-8):</p> <p>无异常 {&quot;code&quot;:&quot;200&quot;}</p> <p>有异常 {&quot;code&quot;:&quot;错误码&quot;,&quot;message&quot;:&quot;错误信息&quot;}</p> <h3>公共请求参数</h3> <table> <thead> <tr> <th>参数名称</th> <th>类型</th> <th>是否必填</th> <th>最大长度</th> <th>参数描述</th> <th>示例值</th> </tr> </thead> <tbody> <tr> <td>companyId</td> <td>数值</td> <td>是</td> <td>11</td> <td>平台分配给企业的ID</td> <td>52984126340489216</td> </tr> <tr> <td>charset</td> <td>字符</td> <td>是</td> <td>10</td> <td>请求使用的编码格式,如utf-8,gbk等</td> <td>utf-8</td> </tr> <tr> <td>signType</td> <td>字符</td> <td>是</td> <td>10</td> <td>企业生成签名字符串所使用的签名算法类型,目前支持RSA和RSA2,推荐使用RSA2</td> <td>RSA2</td> </tr> <tr> <td>bizContent</td> <td>json</td> <td>是</td> <td>不限</td> <td>请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递</td> <td>-</td> </tr> <tr> <td>timestamp</td> <td>字符</td> <td>是</td> <td>19</td> <td>发送请求的时间,格式&quot;yyyy-MM-dd HH:mm:ss&quot;</td> <td>2023-10-01 08:08:08</td> </tr> <tr> <td>sign</td> <td>字符</td> <td>是</td> <td>344</td> <td>企业请求参数的签名串,详见[数据签名](<a href="https://www.showdoc.com.cn/kycloudopen/11199716093743187">https://www.showdoc.com.cn/kycloudopen/11199716093743187</a> &quot;数据签名&quot;)</td> <td>详见示例</td> </tr> </tbody> </table> <h3>请求参数</h3> <table> <thead> <tr> <th>参数名称</th> <th>类型</th> <th>是否必填</th> <th>最大长度</th> <th>参数描述</th> <th>示例值</th> </tr> </thead> <tbody> <tr> <td>orderId</td> <td>字符</td> <td>是</td> <td>19</td> <td>平台订单ID</td> <td>52984126340489216</td> </tr> <tr> <td>outBizNo</td> <td>字符</td> <td>是</td> <td>50</td> <td>企业唯一订单号,由企业自定义</td> <td>2023100080808</td> </tr> <tr> <td>businessId</td> <td>数值</td> <td>否</td> <td>11</td> <td>平台分配给企业的业务ID</td> <td>52984126340489216</td> </tr> <tr> <td>accountType</td> <td>字符</td> <td>是</td> <td>20</td> <td>收款方账户类型,银行卡BANK_ACCOUNT、支付宝ALI_ACCOUNT、微信WX_ACCOUNT</td> <td>ALI_ACCOUNT</td> </tr> <tr> <td>accountNo</td> <td>字符</td> <td>是</td> <td>50</td> <td>收款方账号</td> <td>testaccount@alipay.com</td> </tr> <tr> <td>name</td> <td>字符</td> <td>否</td> <td>20</td> <td>收款方真实姓名,如果非空,将校验收款账号与姓名一致性。</td> <td>张三</td> </tr> <tr> <td>phone</td> <td>字符</td> <td>否</td> <td>11</td> <td>收款方手机号码</td> <td>13100000000</td> </tr> <tr> <td>idCardNo</td> <td>字符</td> <td>否</td> <td>18</td> <td>收款方身份证号码</td> <td>33010120231001111</td> </tr> <tr> <td>transAmount</td> <td>数值</td> <td>是</td> <td>20</td> <td>订单金额,单位元,精确到小数点后两位(最低金额0.1元)</td> <td>10.01</td> </tr> <tr> <td>paymentStatus</td> <td>字符</td> <td>是</td> <td></td> <td>支付状态 支付中PAYING,支付成SUCCESS,支付失败FAILED,退款REFUND,余额不足挂起HANGUP</td> <td>PAYING</td> </tr> <tr> <td>paymentDate</td> <td>字符</td> <td>否</td> <td>19</td> <td>订单支付时间,格式&quot;yyyy-MM-dd HH:mm:ss&quot;</td> <td>2023-10-01 08:08:08</td> </tr> <tr> <td>paymentVoucher</td> <td>字符</td> <td>否</td> <td></td> <td>交易凭证</td> <td><a href="https://xiyk.oss-cn-hangzhou.aliyuncs.com/voucher/alipay/FUND_TRANSFER_20231001020070011500610047995529.pdf"><a href="https://oss-cn-hangzhou.aliyuncs.com/123456.pdf">https://oss-cn-hangzhou.aliyuncs.com/123456.pdf</a></a></td> </tr> <tr> <td>remark</td> <td>字符</td> <td>否</td> <td>50</td> <td>备注</td> <td>服务费</td> </tr> <tr> <td>failReason</td> <td>字符</td> <td>否</td> <td>255</td> <td>查询到的订单状态为FAIL失败或REFUND退票时,返回具体的原因</td> <td>无法入账,退汇原因为账号户名不符</td> </tr> </tbody> </table> <h2>回执单回调</h2> <h3>请求方式</h3> <ul> <li>POST</li> </ul> <p>平台从支付通道获取到回执单后进行回调通知。针对回调code不为200或http请求超时,会发起重试,重试5次</p> <p>企业接收回调后返回报文例子(报文格式 application/json;charset=UTF-8):</p> <p>无异常 {&quot;code&quot;:&quot;200&quot;}</p> <p>有异常 {&quot;code&quot;:&quot;错误码&quot;,&quot;message&quot;:&quot;错误信息&quot;}</p> <h3>公共请求参数</h3> <table> <thead> <tr> <th>参数名称</th> <th>类型</th> <th>是否必填</th> <th>最大长度</th> <th>参数描述</th> <th>示例值</th> </tr> </thead> <tbody> <tr> <td>companyId</td> <td>数值</td> <td>是</td> <td>11</td> <td>平台分配给企业的ID</td> <td>52984126340489216</td> </tr> <tr> <td>charset</td> <td>字符</td> <td>是</td> <td>10</td> <td>请求使用的编码格式,如utf-8,gbk等</td> <td>utf-8</td> </tr> <tr> <td>signType</td> <td>字符</td> <td>是</td> <td>10</td> <td>企业生成签名字符串所使用的签名算法类型,目前支持RSA和RSA2,推荐使用RSA2</td> <td>RSA2</td> </tr> <tr> <td>bizContent</td> <td>json</td> <td>是</td> <td>不限</td> <td>请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递</td> <td>-</td> </tr> <tr> <td>timestamp</td> <td>字符</td> <td>是</td> <td>19</td> <td>发送请求的时间,格式&quot;yyyy-MM-dd HH:mm:ss&quot;</td> <td>2023-10-01 08:08:08</td> </tr> <tr> <td>sign</td> <td>字符</td> <td>是</td> <td>344</td> <td>企业请求参数的签名串,详见[数据签名](<a href="https://www.showdoc.com.cn/kycloudopen/11199716093743187">https://www.showdoc.com.cn/kycloudopen/11199716093743187</a> &quot;数据签名&quot;)</td> <td>详见示例</td> </tr> </tbody> </table> <h3>请求参数</h3> <table> <thead> <tr> <th>参数名称</th> <th>类型</th> <th>是否必填</th> <th>最大长度</th> <th>参数描述</th> <th>示例值</th> </tr> </thead> <tbody> <tr> <td>orderId</td> <td>字符</td> <td>是</td> <td>19</td> <td>平台订单ID</td> <td>52984126340489216</td> </tr> <tr> <td>outBizNo</td> <td>字符</td> <td>是</td> <td>50</td> <td>企业唯一订单号,由企业自定义</td> <td>2023100080808</td> </tr> <tr> <td>paymentVoucher</td> <td>字符</td> <td>否</td> <td></td> <td>交易凭证</td> <td><a href="https://xiyk.oss-cn-hangzhou.aliyuncs.com/voucher/alipay/FUND_TRANSFER_20231001020070011500610047995529.pdf"><a href="https://oss-cn-hangzhou.aliyuncs.com/123456.pdf">https://oss-cn-hangzhou.aliyuncs.com/123456.pdf</a></a></td> </tr> </tbody> </table> <h3>公共错误码</h3> <p>参考:[公共错误码](<a href="https://www.showdoc.com.cn/kycloudopen/11199459988358587">https://www.showdoc.com.cn/kycloudopen/11199459988358587</a> &quot;公共错误码&quot;)</p>

页面列表

ITEM_HTML