定向开放文档

alipay.ebpp.invoice.token.batchquery(根据查询令牌获取发票要素列表) 在线调试(沙箱环境)

根据用户通过发票管家选择发票列表产生的请求令牌获取用户选择发票要素列表

公共参数

请求地址

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

公共请求参数

参数 类型 是否必填最大长度描述示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 alipay.ebpp.invoice.token.batchquery
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
app_auth_token String 40 详见应用授权概述
biz_content String 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档

请求参数

参数 类型 是否必填 最大长度 描述 示例值
invoice_token String 必选 34 查询请求令牌
通过唤起支付宝钱包后用户进入发票管家选择发票列表后创建,并通过isv接收url回传给isv
0136d80096e34a07a528db7cc5bc442888s
scene String 必选 20 发票要素获取应用场景
固定值
INVOICE_EXPENSE
INVOICE_EXPENSE

响应参数

参数 类型 是否必填 最大长度 描述 示例值
user_id String 必填 16 支付宝用户id 20880000000000000
invoice_element_list InvoiceElementModel 必填 发票要素列表
expense_status String 必填 30 发票报销状态
取值范围:
WAIT_EXPENSE-未报销
EXPENSE_PROCESSING-报销中
EXPENSE_FINISHED-已报销
WAIT_EXPENSE
invoice_status String 必填 20 发票状态 
取值范围
SUCCEED-正常蓝票
EXPIRED-已失效
SUCCEED
invoice_code String 必填 12 发票代码 1234567890
invoice_no String 必填 10 发票号码 12345678
invoice_amount String 必填 10 发票金额 100
invoice_date String 必填 16 开票日期 2017-07-11
invoice_kind String 必填 20 发票类型
可选值
PLAIN:增值税电子普通发票
SPECIAL:增值税专用发票
PLAIN_INVOICE:增值税普通发票
PAPER_INVOICE:增值税普通发票(卷式)
SALSE_INVOICE:机动车销售统一发票
PLAIN
payer_name String 必填 100 购方名称 支付宝(中国)技术有限公司
payer_tax_no String 可选 20 购方税号 1234567890
payee_name String 必填 100 销方名称 国力大酒店
payee_tax_no String 可选 25 销方税号 1234567890
invoice_img_url String 可选 100 发票pdf文件转换后jpg预览地址 https://www.alipay.com
has_risk Boolean 必填 5 该发票可能存在异常,请核实后使用
true:无异常
false:存在异常
true
has_pdf_file Boolean 必填 5 发票是否有pdf文件 true

请求示例

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayEbppInvoiceTokenBatchqueryRequest request = new AlipayEbppInvoiceTokenBatchqueryRequest();
request.setBizContent("{" +
"\"invoice_token\":\"0136d80096e34a07a528db7cc5bc442888s\"," +
"\"scene\":\"INVOICE_EXPENSE\"" +
"  }");
AlipayEbppInvoiceTokenBatchqueryResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

{
    "alipay_ebpp_invoice_token_batchquery_response": {
        "code": "10000",
        "msg": "Success",
        "user_id": "20880000000000000",
        "invoice_element_list": [
            {
                "expense_status": "WAIT_EXPENSE",
                "invoice_status": "SUCCEED",
                "invoice_code": "1234567890",
                "invoice_no": "12345678",
                "invoice_amount": "100",
                "invoice_date": "2017-07-11",
                "invoice_kind": "PLAIN",
                "payer_name": "支付宝(中国)技术有限公司",
                "payer_tax_no": "1234567890",
                "payee_name": "国力大酒店",
                "payee_tax_no": "1234567890",
                "invoice_img_url": "https://www.alipay.com",
                "has_risk": true,
                "has_pdf_file": true
            }
        ]
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

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

业务错误码

公共错误码

错误码错误描述解决方案
SYSTEM_ERROR 系统繁忙 请稍候再试
INVOICE_INVALID_TOKEN 无效的发票查询令牌 令牌已过期或令牌非法,请用户重新生成查询令牌
PERMISSION_DENIED isv发票查询权限校验失败 isv没有发票查询权限
PARAMETER_ILLEGAL 参数检查失败 scene和invoice_token不能为空