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

alipay.ebpp.pdeduct.sign.cancel (缴费直连代扣取消签约)

缴费直连代扣,用户取消签约接口

公共参数

请求地址:
环境 HTTPS请求地址
正式环境 https://openapi.alipay.com/gateway.do
公共请求参数:
参数 类型 是否必填 最大长度 描述 示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 alipay.ebpp.pdeduct.sign.cancel
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 详见应用授权概述

请求参数

参数 类型 是否必填 最大长度 描述 示例值
user_id String 必须 16 用户ID 2088123411112222
agreement_id String 必须 32 支付宝代扣协议ID 20160512331244123124421
agent_channel String 必须 30 此值只是供代扣中心做最后的渠道统计用,并不做值是什么的强校验,只要不为空就可以 操作来源 PUBLICPLATFORM:服务窗
agent_code String 必须 30 标识发起方的ID,从服务窗发起则为appId的值,appId即开放平台分配给接入ISV的id,此处也可以随便真其它值,只要能标识唯一即可 201603012984123
pay_password_token String 必须 32 需要用户首先处于登陆态,然后访问https://ebppprod.alipay.com/deduct/enterMobileicPayPassword.htm?cb=自己指定的回跳连接地址,访问页面后会进到独立密码校验页,用户输入密码校验成功后,会生成token回调到指定的回跳地址,如果设置cb=www.baidu.com则最后回调的内容是www.baidu.com?token=312314ADFDSFAS,然后签约时直接取得地址后token的值即可 11505a6f41688644a4b85f9bf80ef071

公共响应参数

参数 类型 是否必填 最大长度 描述 示例值
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=

响应参数

参数 类型 是否必填 最大长度 描述 示例值
agreement_id String 必填 - 支付宝代扣协议ID 20441111111
out_agreement_id String 选填 30 商户代扣协议ID 23433333333
agreement_status String 必填 32 支付宝协议状态。解约成功则返回success success

请求示例

  • 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");
AlipayEbppPdeductSignCancelRequest request = new AlipayEbppPdeductSignCancelRequest();
request.setUserId("2088123411112222");
request.setAgreementId("20160512331244123124421");
request.setAgentChannel("操作来源
PUBLICPLATFORM:服务窗");
request.setAgentCode("201603012984123");
request.setPayPasswordToken("11505a6f41688644a4b85f9bf80ef071");
AlipayEbppPdeductSignCancelResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

  • JSON示例
{
	"alipay_ebpp_pdeduct_sign_cancel_response":{
		"agreement_id":"20441111111",
		"agreement_status":"success",
		"out_agreement_id":"23433333333"
	}
}

异常示例

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

业务错误码

错误码 错误描述 解决方案
isp.unknow-error 支付宝系统未知异常 支付宝系统未知异常
isv.arguments-error 参数不合法 检查输入参数是否正常
isv.sign-info-not-exist 签约协议不存在 签约协议不存在
isv.cancel-sign-failure 取消签约失败 分析代码日志,修复问题
DEDUCT_SIGN_INFO_NOT_EXIST 代扣协议不存在,一般情况下是只传来的协议ID和用户ID没有查询到协议 需要检测传的agreement_id是否正确,或是机构是否有单边账的情况
QUERY_DEDUCT_SIGN_INFO_ERROR 查询协议失败,一般是指网络异常,或数据库异常 过一会再次重试

公共错误码

返回
顶部