alipay.ebpp.invoice.title.list.get(获取指定用户所有的有效抬头列表) 在线调试(沙箱环境)

用于服务商在用户授权的情况下获取用户的发票抬头列表供用户使用。

公共参数

请求地址

环境HTTPS请求地址
正式环境 https://openapi.alipay.com/gateway.do

公共请求参数

参数 类型 是否必填最大长度描述示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 alipay.ebpp.invoice.title.list.get
format String 40 仅支持JSON JSON
charset String 10 请求使用的编码格式,如utf-8,gbk,gb2312等 utf-8
sign_type String 10 商户生成签名字符串所使用的签名算法类型,目前支持RSA2和RSA,推荐使用RSA2 RSA2
sign String 344 商户请求参数的签名串,详见签名 详见示例
timestamp String 19 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" 2014-07-24 03:07:50
version String 3 调用的接口版本,固定为:1.0 1.0
auth_token String 40 针对用户授权接口,获取用户相关数据时,用于标识用户授权关系。详见用户信息授权
app_auth_token String 40 详见应用授权概述
biz_content String 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档

请求参数

参数 类型 是否必填 最大长度 描述 示例值
user_id String 必选 16 支付宝用户id 2088000000000000

响应参数

参数 类型 是否必填 最大长度 描述 示例值
title_list InvoiceTitleModel 选填 抬头列表
user_id String 可选 25 支付宝用户id 2088000000000000
title_name String 必填 50 抬头名称 支付宝(中国)网络技术有限公司
title_type String 可选 20 抬头类型
字段值有两种情况抬:
PERSONAL(个人)
CORPORATION(单位)
CORPORATION
is_default Boolean 可选 5 是否为用户设置默认抬头
字段值包括两种情况:
false(非默认)
true(默认抬头)
true
user_mobile String 可选 14 电话号码 13900000000
tax_register_no String 可选 20 纳税人识别号 123
user_address String 可选 100 地址 杭州市 西湖区 天目山路 黄龙时代广场
open_bank_name String 可选 100 开户银行 中国建设银行
open_bank_account String 可选 25 银行账号 6332000010001000

请求示例

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayEbppInvoiceTitleListGetRequest request = new AlipayEbppInvoiceTitleListGetRequest();
request.setBizContent("{" +
"\"user_id\":\"2088000000000000\"" +
"  }");
AlipayEbppInvoiceTitleListGetResponse response = alipayClient.execute(request,accessToken);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

{
    "alipay_ebpp_invoice_title_list_get_response": {
        "code": "10000",
        "msg": "Success",
        "title_list": [
            {
                "user_id": "2088000000000000",
                "title_name": "支付宝(中国)网络技术有限公司",
                "title_type": "CORPORATION",
                "is_default": true,
                "user_mobile": "13900000000",
                "tax_register_no": "123",
                "user_address": "杭州市 西湖区 天目山路 黄龙时代广场",
                "open_bank_name": "中国建设银行",
                "open_bank_account": "6332000010001000"
            }
        ]
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

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

业务错误码

公共错误码

错误码错误描述解决方案
TITLE_LIST_NOT_EXIST 发票抬头列表不存在 此用户在发票管家没有设置抬头,请用户移步到支付宝->发票管家->添加抬头 之后再发起抬头查询
PARAMETER_ILLEGAL 参数不合法 参数user_id为16位2088开头的字符串,请核对请求参数
SYSTEM_ERROR 系统繁忙 稍后重试,若重试仍然报错,请及时联系支付宝技术支持(联系方式见链接:https://support.open.alipay.com/alipay/support/index.htm)
onlineServer