(1)请求参数
参数 | 是否必输 | 说明 |
---|---|---|
appid | 是 | 合作方唯一凭证 |
sign_type | 是 | 签名算法类型,例:SHA256 |
encrypt_data | 是 | 加密数据 |
sign | 是 | 合作方签名串,32位随机字符串,用于签名、加密、HMAC等 |
timestamp | 是 | 时间戳,格式:yyyy-MM-dd HH:mm:ss |
biz_data | 是 | 请求参数合集 |
encrypt_type | 是 | 加密算法类型,例:AES |
deviceid | 否 | 设备编号 |
nonce | 是 | 与时间戳结合防止重放攻击 |
(2)返回参数
参数 | 说明 |
---|---|
code | 网关返回码 |
msg | 网关返回描述 |
biz_encrypt | 返回加密内容 |
biz_content | 返回内容 |
sign | 网关签名串 |
responseid | 响应日志号 |
通用响应码
响应码 | 备注 |
---|---|
"4001" | 无效的请求路径/后台无此接口 |
"4002" | 应用无权限访问此接口 |
"4003" | 应用访问此接口的权限异常 |
"4004" | 无效的appid,请开发者检查appid的正确性 |
"5001" | 签名验签失败 |
"5002" | 不支持的加密方法 |
"5003" | 重放请求报错 |
"5004" | 请求报文字段缺失 |
"5005" | 请求报文必输字段为空 |
编号 | API名称 | 请求入口 |
---|
接口描述:客户进入缴费中心,根据当前城市定位或手动选择的城市,渠道编码、以及一级分类(例如生活缴费)来查询该城市下所拥有的所有二级缴费类别(例如水费)。
请求入口: https://openbank.abchina.com/GateWay/openabc/api/sociallifepayment/gettypes/v1
沙盒测试请求入口: https://openbank.abchina.com/GateWay/SandBox/openabc/api/sociallifepayment/gettypes/v1
通用请求参数:见1.1节
特定请求参数:
参数 | 是否必输 | 说明 |
---|
请求的JSON格式:
encrypt_data的加密结构示例:
特定返回参数:
参数 | 说明 |
---|
typeListData的结构:
参数 | 说明 |
---|
响应的JSON格式:
biz_encrypt的解密结构示例:
接口描述:客户在选择某个缴费项目后,通过本接口可查询获得该缴费项目的详细信息。
请求入口: https://openbank.abchina.com/GateWay/openabc/api/sociallifepayment/getitembyepaycode/v1
沙盒测试请求入口: https://openbank.abchina.com/GateWay/SandBox/openabc/api/sociallifepayment/getitembyepaycode/v1
通用请求参数:见1.1节
特定请求参数:
参数 | 是否必输 | 说明 |
---|
请求的JSON格式:
encrypt_data的加密结构示例:
特定返回参数:
参数 | 说明 |
---|
响应的JSON格式:
biz_encrypt的解密结构示例:
接口描述:客户选择某个二级缴费类别后,通过调用本接口可以查询到符合条件的所有缴费项目列表。
请求入口: https://openbank.abchina.com/GateWay/openabc/api/sociallifepayment/getitembyareatype/v1
沙盒测试请求入口: https://openbank.abchina.com/GateWay/SandBox/openabc/api/sociallifepayment/getitembyareatype/v1
通用请求参数:见1.1节
特定请求参数:
参数 | 是否必输 | 说明 |
---|
请求的JSON格式:
encrypt_data的加密结构示例:
特定返回参数:
参数 | 说明 |
---|
typeListData的结构:
参数 | 说明 |
---|
响应的JSON格式:
biz_encrypt的解密结构示例:
接口描述:客户选择某个二级缴费类别后,通过调用本接口可以查询到符合条件的商e付类缴费项目列表。
请求入口: https://openbank.abchina.com/GateWay/openabc/api/sociallifepayment/getmerchantitems/v1
沙盒测试请求入口: https://openbank.abchina.com/GateWay/SandBox/openabc/api/sociallifepayment/getmerchantitems/v1
通用请求参数:见1.1节
特定请求参数:
参数 | 是否必输 | 说明 |
---|
请求的JSON格式:
encrypt_data的加密结构示例:
特定返回参数:
参数 | 说明 |
---|
typeListData的结构:
参数 | 说明 |
---|
响应的JSON格式:
biz_encrypt的解密结构示例:
接口描述:客户输入缴费项目编号的缴费要素信息后,通过调用本接口可以查询到该缴费项和缴费信息要素对应的账单内容。
请求入口: https://openbank.abchina.com/GateWay/openabc/api/sociallifepayment/querybill/v1
沙盒测试请求入口: https://openbank.abchina.com/GateWay/SandBox/openabc/api/sociallifepayment/querybill/v1
通用请求参数:见1.1节
特定请求参数:
参数 | 是否必输 | 说明 |
---|
请求的JSON格式:
encrypt_data的加密结构示例:
特定返回参数:
参数 | 说明 |
---|
json的结构为:
参数 | 说明 |
---|
feeDetails的结构为:
参数 | 说明 |
---|
响应的JSON格式:
biz_encrypt的解密结构示例(单一账单):
biz_encrypt的解密结构示例(多账单):
接口描述:相关渠道通过开放银行平台接口进行对接后,客户查看缴费记录时,可通过本接口输入缴费流水号,来获取符合条件的缴费流水。
请求入口: https://openbank.abchina.com/GateWay/openabc/api/sociallifepayment/gettranstracebyid/v1
沙盒测试请求入口: https://openbank.abchina.com/GateWay/SandBox/openabc/api/sociallifepayment/gettranstraceby
通用请求参数:见1.1节
特定请求参数:
参数 | 是否必输 | 说明 |
---|
请求的JSON格式:
encrypt_data的加密结构示例:
特定返回参数:
参数 | 说明 |
---|
响应的JSON格式:
biz_encrypt的解密结构示例:
接口描述:相关渠道通过开放银行平台接口进行对接后,客户查看缴费记录时,通过选择合适的查询条件,可以通过本接口来获取符合条件的缴费流水。
请求入口: https://openbank.abchina.com/GateWay/openabc/api/sociallifepayment/gettranstracebycondition/v1
沙盒测试请求入口: https://openbank.abchina.com/GateWay/SandBox/openabc/api/sociallifepayment/gettranstracebycondition/v1
通用请求参数:见1.1节
特定请求参数:
参数 | 是否必输 | 说明 |
---|
请求参数说明:16位客户号、付款银行卡号、三方渠道客户号至少传入一个
请求的JSON格式:
encrypt_data的加密结构示例:
特定返回参数:
参数 | 说明 |
---|
json的结构:
参数 | 说明 |
---|
响应的JSON格式:
biz_encrypt的解密结构示例:
接口描述:相关渠道通过开放银行平台接口进行对接后,客户通过选择合适的查询条件,可以通过本接口来获取符合条件的分页缴费流水,且不限定查询时间跨度。
请求入口: https://openbank.abchina.com/GateWay/openabc/api/sociallifepayment/gettranstracebypage/v1
沙盒测试请求入口: https://openbank.abchina.com/GateWay/SandBox/openabc/api/sociallifepayment/gettranstracebypage/v1
通用请求参数:见1.1节
特定请求参数:
参数 | 是否必输 | 说明 |
---|
请求参数说明:16位客户号、付款银行卡号、三方渠道客户号至少传入一个
请求的JSON格式:
encrypt_data的加密结构示例:
特定返回参数:
参数 | 说明 |
---|
result的结构:
参数 | 说明 |
---|
响应的JSON格式:
biz_encrypt的解密结构示例:
接口描述:根据客户号,可以查询获得该客户在农行所有缴费渠道产生的定制缴费项列表,定制缴费项全渠道共享且不区分渠道。不区分农行客户号和行外客户号。
请求入口: https://openbank.abchina.com/GateWay/openabc/api/sociallifepayment/getcustomizeditems/v1
沙盒测试请求入口: https://openbank.abchina.com/GateWay/SandBox/openabc/api/sociallifepayment/getcustomizeditems/v1
通用请求参数:见1.1节
特定请求参数:
参数 | 是否必输 | 说明 |
---|
请求的JSON格式:
encrypt_data的加密结构示例:
特定返回参数:
参数 | 说明 |
---|
响应的JSON格式:
biz_encrypt的解密结构示例:
接口描述:修改定制缴费项备注名称的功能。
请求入口: https://openbank.abchina.com/GateWay/openabc/api/sociallifepayment/updatecustomizeditems/v1
沙盒测试请求入口: https://openbank.abchina.com/GateWay/SandBox/openabc/api/sociallifepayment/updatecustomizeditems/v1
通用请求参数:见1.1节
特定请求参数:
参数 | 是否必输 | 说明 |
---|
请求的JSON格式:
encrypt_data的加密结构示例:
特定返回参数:
参数 | 说明 |
---|
响应的JSON格式:
biz_encrypt的解密结构示例:
接口描述:根据定制缴费项编号删除定制缴费项的功能。
请求入口: https://openbank.abchina.com/GateWay/openabc/api/sociallifepayment/deletecustomizeditems/v1
沙盒测试请求入口: https://openbank.abchina.com/GateWay/SandBox/openabc/api/sociallifepayment/deletecustomizeditems/v1
通用请求参数:见1.1节
特定请求参数:
参数 | 是否必输 | 说明 |
---|
请求的JSON格式:
encrypt_data的加密结构示例:
特定返回参数:
参数 | 说明 |
---|
响应的JSON格式:
biz_encrypt的解密结构示例:
接口描述:根据定制缴费项编号删除定制缴费项的功能。
请求入口: https://openbank.abchina.com/GateWay/openabc/api/sociallifepayment/deletecustomizeditems/v1
沙盒测试请求入口: https://openbank.abchina.com/GateWay/SandBox/openabc/api/sociallifepayment/deletecustomizeditems/v1
通用请求参数:见1.1节
特定请求参数:
参数 | 是否必输 | 说明 |
---|
请求的JSON格式:
encrypt_data的加密结构示例:
特定返回参数:
参数 | 说明 |
---|
响应的JSON格式:
biz_encrypt的解密结构示例:
接口描述:线上渠道通过调用缴费中心账单查询接口查出账单后,在客户输入相关的缴费要素信息并选择缴费时,可以先调用缴费中心提供的商E付下单接口实现下单,下单成功后能够顺利取到token号及商E付支付的URL,此时便可通过调用掌银的快E付组件或跳转商E付支付页面完成支付。可在输出参数中获取聚合支付二维码,进行农行掌银或微信扫码完成支付,此外支持银联下单支付。
请求入口: https://openbank.abchina.com/GateWay/openabc/api/sociallifepayment/createorder/v1
沙盒测试请求入口: https://openbank.abchina.com/GateWay/SandBox/openabc/api/sociallifepayment/createorder/v1
通用请求参数:见1.1节
特定请求参数:
参数 | 是否必输 | 说明 |
---|
请求的JSON格式:
encrypt_data的加密结构示例:
特定返回参数:
参数 | 说明 |
---|
响应的JSON格式:
biz_encrypt的解密结构示例:
接口描述:生活缴费微信支付下单接口。
请求入口: https://openbank.abchina.com/GateWay/openabc/api/sociallifepayment/wechatpay/v1
沙盒测试请求入口: https://openbank.abchina.com/GateWay/SandBox/openabc/api/sociallifepayment/wechatpay/v1
通用请求参数:见1.1节
特定请求参数:
参数 | 是否必输 | 说明 |
---|
请求的JSON格式:
encrypt_data的加密结构示例:
特定返回参数:
参数 | 说明 |
---|
响应的JSON格式:
biz_encrypt的解密结构示例:
接口描述:生活缴费支付宝支付下单接口。
请求入口: https://openbank.abchina.com/GateWay/openabc/api/sociallifepayment/alipay/v1
沙盒测试请求入口: https://openbank.abchina.com/GateWay/SandBox/openabc/api/sociallifepayment/alipay/v1
通用请求参数:见1.1节
特定请求参数:
参数 | 是否必输 | 说明 |
---|
请求的JSON格式:
encrypt_data的加密结构示例:
特定返回参数:
参数 | 说明 |
---|
响应的JSON格式:
biz_encrypt的解密结构示例:
接口描述:缴费中心-查询商户交易模式。
请求入口: https://openbank.abchina.com/GateWay/openabc/api/sociallifepayment/findtranstype/v1
沙盒测试请求入口: https://openbank.abchina.com/GateWay/SandBox/openabc/api/sociallifepayment/findtranstype/v1
通用请求参数:见1.1节
特定请求参数:
参数 | 是否必输 | 说明 |
---|
请求的JSON格式:
encrypt_data的加密结构示例:
特定返回参数:
参数 | 说明 |
---|
响应的JSON格式:
biz_encrypt的解密结构示例: