API开发文档简介
本文阅读对象：使用 商户自服务系统的技术架构师、研发工程师、系统运维工程师。通过本文档，商户可了解 芸数据 接入的技术、接入的产品业务、接入的流程、接入规范等信息，以便于商户顺利完成接入工作。
接入网关
请登录商户中心，API管理 开发文档中 查看网关地址和API对接参数。
短信接口
提交方式：POST
地址： 接入网关/externalduanxin
| 参数名称 |
参数含义 |
是否必填 |
参数说明 |
| username |
商户号 |
是 |
登录商户号 |
| key |
芸数据key |
是 |
在商户中心查询 |
| mobile |
手机号码 |
是 |
发送手机号 |
| tpl_id |
短信模板ID |
否 |
|
| tpl_value |
短信参数 |
否 |
|
返回值/json
| 参数名称 |
参数含义 |
是否必填 |
参数说明 |
| msg |
返回说明 |
是 |
|
| error_code |
发送状态 |
是 |
1成功 0失败 |
| code |
验证码 |
否 |
发送验证码成功才返回 |
充值话费接口
提交方式：POST
地址： 接入网关/externalhuafei
| 参数名称 |
参数含义 |
是否必填 |
参数说明 |
| username |
商户号 |
是 |
登录商户号 |
| key |
芸数据key |
是 |
在商户中心查询 |
| mobile |
手机号码 |
是 |
发送手机号 |
| pervalue |
充值面额 |
是 |
比如充值100 填写100 |
返回值/json
| 参数名称 |
参数含义 |
是否必填 |
参数说明 |
| msg |
返回说明 |
是 |
|
| error_code |
发送状态 |
是 |
1成功 0失败 |
充值油卡接口
提交方式：POST
地址： 接入网关/externaljiayouka
| 参数名称 |
参数含义 |
是否必填 |
参数说明 |
| username |
商户号 |
是 |
登录商户号 |
| key |
芸数据key |
是 |
在商户中心查询 |
| tel |
手机号码 |
是 |
发送手机号 |
| price |
充值面额 |
是 |
比如充值100 填写100 |
| number |
充值卡号 |
是 |
充值卡号 |
| name |
姓 名 |
是 |
充值卡姓名 |
| types |
充值类型 |
是 |
1:中石化、2:中石油； |
返回值/json
| 参数名称 |
参数含义 |
是否必填 |
参数说明 |
| msg |
返回说明 |
是 |
|
| error_code |
发送状态 |
是 |
1成功 0失败 |
支付宝代付接口
提交方式：POST
地址： 接入网关/index/alipayapi/alipaymentuser
| 参数名称 |
参数含义 |
是否必填 |
参数说明 |
| username |
商户号 |
是 |
登录本平台的账号 |
| access_token |
芸数据key |
是 |
申请商户，通过邮件发送 |
| fee |
代付金额 |
是 |
单位是分，比如打款100 提交10000 |
| aliAccount |
支付宝账号 |
是 |
支付宝账号 |
| aliName |
支付宝姓名 |
是 |
支付宝姓名 |
返回值/json
| 参数名称 |
参数含义 |
是否必填 |
参数说明 |
| msg |
返回说明 |
是 |
msg[提示信息]"
out_biz_no[打款成功时返回单号]"
trans_date[打款成功时返回时间]"
|
| code |
付款状态 |
是 |
10000:标识打款成功,-200:标识打款失败
|
银行卡代付接口
提交方式：POST
地址： 接入网关/index/alipayapi/bankpaymentuser
| 参数名称 |
参数含义 |
是否必填 |
参数说明 |
| username |
商户号 |
是 |
登录本平台的账号 |
| access_token |
芸数据key |
是 |
申请商户，通过邮件发送 |
| fee |
代付金额 |
是 |
单位是分，比如打款100 提交10000 |
| bankAccount |
银行卡账号 |
是 |
银行卡账号 |
| bankName |
开户姓名 |
是 |
开户姓名 |
| bank |
银行名称 |
是 |
银行名称，譬如中国银行 |
| partName |
支行行名称 |
是 |
支行名称，譬如中国银行北京支行 |
| idCard |
身份证 |
是 |
身份证 |
| frontPath |
身份证正面 |
是 |
身份证正面 |
| backPath |
身份证反面 |
是 |
身份证反面 |
返回值/json
| 参数名称 |
参数含义 |
是否必填 |
参数说明 |
| msg |
返回说明 |
是 |
msg[提示信息]"
out_biz_no[打款成功时返回单号]"
trans_date[打款成功时返回时间]"
|
| code |
付款状态 |
是 |
10000:标识打款成功,-200:标识打款失败
|
银行卡代付查询接口
提交方式：POST
地址： 接入网关/index/alipayapi/bankpaymentquery
| 参数名称 |
参数含义 |
是否必填 |
参数说明 |
| username |
商户号 |
是 |
登录本平台的账号 |
| access_token |
芸数据key |
是 |
申请商户，通过邮件发送 |
| out_biz_no |
代付订单号 |
是 |
代付成功时返回的订单号 |
返回值/json
| 参数名称 |
参数含义 |
是否必填 |
参数说明 |
| msg |
返回说明 |
是 |
状态描述信息
|
| code |
查询状态 |
是 |
10000:查询成功
-200:查询失败
|
| status |
代付状态 |
否 |
1:代付成功
2:代付失败
0:处理中
|
| out_biz_no |
代付订单号 |
否 |
系统订单号 |
| trans_date |
交易时间 |
否 |
代付完成时间 |
| fee |
代付金额 |
否 |
实际代付金额（分） |
实名校验
提交方式：POST
地址： 接入网关/externalhuafei
| 参数名称 |
参数含义 |
是否必填 |
参数说明 |
| Action |
商户号 |
是 |
登录商户号 |
| Version |
芸数据key |
是 |
在商户中心查询 |
| mobile |
手机号码 |
是 |
发送手机号 |
| ImageUrl |
身份证人像面的Url地址 |
是 |
本接口取值：CheckIdCardInformation |
返回值/json
| 参数名称 |
参数含义 |
是否必填 |
参数说明 |
| msg |
返回说明 |
是 |
|
| error_code |
发送状态 |
是 |
1成功 0失败 |
