文档中心 > API类目 > 生活缴费API

alipay.ebpp.pdeduct.bill.pay.status (缴费直连代扣订单支付状态查询)

缴费直连代扣

公共参数

请求地址:
环境 HTTPS请求地址
正式环境 https://openapi.alipay.com/gateway.do
公共请求参数:
参数 类型 是否必填 最大长度 描述 示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 alipay.ebpp.pdeduct.bill.pay.status
format String 40 仅支持JSON JSON
charset String 10 请求使用的编码格式,如utf-8,gbk,gb2312等 utf-8
sign_type String 10 商户生成签名字符串所使用的签名算法类型,目前支持RSA2和RSA,推荐使用RSA2 RSA2
sign String 256 商户请求参数的签名串,详见签名 详见示例
timestamp String 19 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" 2014-07-24 03:07:50
version String 3 调用的接口版本,固定为:1.0 1.0
app_auth_token String 40 详见应用授权概述

请求参数

参数 类型 是否必填 最大长度 描述 示例值
out_order_no String 必须 32 商户代扣业务流水 12312313
agreement_id String 必须 32 支付宝用户ID 2088123123421312

公共响应参数

参数 类型 是否必填 最大长度 描述 示例值
code String - 网关返回码,详见文档 40004
msg String - 网关返回码描述,详见文档 Business Failed
sub_code String - 业务返回码,详见文档 ACQ.TRADE_HAS_SUCCESS
sub_msg String - 业务返回码描述,详见文档 交易已被支付
sign String - 签名,详见文档 DZXh8eeTuAHoYE3w1J+POiPhfDxOYBfUNn1lkeT/V7P4zJdyojWEa6IZs6Hz0yDW5Cp/viufUb5I0/V5WENS3OYR8zRedqo6D+fUTdLHdc+EFyCkiQhBxIzgngPdPdfp1PIS7BdhhzrsZHbRqb7o4k3Dxc+AAnFauu4V6Zdwczo=

响应参数

参数 类型 是否必填 最大长度 描述 示例值
status String 必填 2 支付宝订单支付状态。
0:未知状态。
1:支付成功。
2:支付失败。
0
agreement_id String 必填 32 支付宝协议流水 2919219429194
out_order_no String 必填 32 外部订单流水 21929910124
order_no String 选填 32 支付宝流billNo 2015010122003385
order_result_code String 选填 50 订单的结果码 PAY_FAIL
order_result_msg String 选填 500 订单的结果描述 AE0110270001_支付金额不足

请求示例

  • JAVA
  • .NET
  • PHP
  • HTTP请求源码
AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayEbppPdeductBillPayStatusRequest request = new AlipayEbppPdeductBillPayStatusRequest();
request.setOutOrderNo("12312313");
request.setAgreementId("2088123123421312");
AlipayEbppPdeductBillPayStatusResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

  • JSON示例
{
	"alipay_ebpp_pdeduct_bill_pay_status_response":{
		"order_no":"2015010122003385",
		"order_result_code":"PAY_FAIL",
		"order_result_msg":"AE0110270001_支付金额不足",
		"agreement_id":"2919219429194",
		"out_order_no":"21929910124",
		"status":"0"
	}
}

异常示例

  • JSON示例
{
	"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE",
	"alipay_ebpp_pdeduct_bill_pay_status_response":{
		"msg":"Service Currently Unavailable",
		"code":"20000",
		"sub_msg":"系统繁忙",
		"sub_code":"isp.unknow-error"
	}
}

业务错误码

错误码 错误描述 解决方案
BILL_NOT_EXIST 订单不存在 没有查询到订单,说明扣款时掉单了,需要再度发起
PARAMETER_ILLEGAL 参数有误,必填参数没有填 检查一下是否参数都填了
SYSTEM_ERROR 系统异常 一般是查询数据库或是网络异常,建议稍后再试

公共错误码

返回
顶部