POS电子凭条

数据 收单机构 商户 发卡机构 快速接入
提供POS电子凭证查询、下载,实现收单机构或商户对签购单的长期保管、备查。

接入服务商:银联开放平台

API ID:473

接口状态:正常

业务申请
暂不支持测试

接口名称

获取token

接口描述

产品token是调用POS电子凭条产品的全局唯一接口调用凭据,用户调用各接口时都需使用产品token。

接口地址

测试地址: 暂无


生产地址: https://openapi.unionpay.com/upapi/voucher/token

请求方式

HTTP GET

请求url参数

名称 标识 字段类型 长度 请求要求 默认值 备注
用户唯一凭证 app_id string M-必填 详情可在登录开放平台后“个人中心-我的信息-API认证信息-API认证账号”中查看
用户唯一凭证密钥 app_secret string M-必填 详情可在登录开放平台后“个人中心-我的信息-API认证信息-API认证密钥”中查看

应答参数

名称 标识 字段类型 长度 请求要求 默认值 备注
产品token token string M-必填 获取到的凭证; 凭证是字符串
过期时间 expire_in long M-必填 凭证有效时间,单位:秒

接口名称

交易信息查询接口

接口描述

交易信息查询接口

接口地址

测试地址: 暂无


生产地址: https://openapi.unionpay.com/upapi/voucher/queryPosVoucherListForMerchant

请求方式

HTTP POST

请求url参数

名称 标识 字段类型 长度 请求要求 默认值 备注
调用接口凭证 token string M-必填 详情请参考“获取token”接口中应答参数“token”的具体数据。
签名信息 sign string M-必填 详细签名算法可参考“接入指南”板块第3条。
请求时间戳 ts long M-必填 单位:毫秒,对于Java一般使用System.currentTimeMillis();获取。

请求报文体参数

名称 标识 字段类型 长度 请求要求 默认值 备注
商户代码 merchantCode string M-必填 商户代码
终端代码 terminalId string O-选填
卡号 priAccountNo string O-选填
开始时间 startDate string M-必填 交易开始日期(yyyyMMdd) 支持查询近一年交易信息
结束时间 endDate long M-必填 交易结束日期(yyyyMMdd)
起始页 start int M-必填
每页记录条数 pageSize int M-必填

应答参数

名称 标识 字段类型 长度 请求要求 默认值 备注
响应编号 respCd string 4 M-必填 0000
响应信息 respMsg string 128 M-必填
查询结果 data map M-必填
数据列表 list array M-必填
Pos交易凭证ID id string M-必填 用于生成凭证的时候定位一笔交易凭证记录
卡号 priAccountNo string M-必填
金额以分为单位 transPosAt int M-必填
商户代码 merchantCode string M-必填
终端代码 terminalId string M-必填
终端批次号 terminalBatchNumber string M-必填
终端流水号 terminalSequence string M-必填
CUPA清算日期 paSettleDate string M-必填 格式为YYYYMMDD
交易日期 transDate string M-必填 格式为YYYYMMDD
交易时间 transDateTime string M-必填 格式为HHMMSS

接口名称

POS电子凭条生成接口

接口描述

根据交易日期查询并生成凭证(如果记录是从交易凭证表中查询到的,只要查询到的结果都能生成交易凭证)

接口地址

测试地址: 暂无


生产地址: https://openapi.unionpay.com/upapi/voucher/createPosTransVoucher

请求方式

HTTP POST

请求url参数

名称 标识 字段类型 长度 请求要求 默认值 备注
调用接口凭证 token string M-必填 详情请参考“获取token”接口中应答参数“token”的具体数据。
签名信息 sign string M-必填 详细签名算法可参考“接入指南”板块第3条。
请求时间戳 ts long M-必填 单位:毫秒,对于Java一般使用System.currentTimeMillis();获取。

请求报文体参数

名称 标识 字段类型 长度 请求要求 默认值 备注
交易日期 transDate string M-必填 格式为YYYYMMDD
交易凭证ID id string M-必填 PosVoucherInfo的id属性

应答参数

名称 标识 字段类型 长度 请求要求 默认值 备注
响应编号 respCd string 4 M-必填 0000
响应信息 respMsg string 128 M-必填
响应数据 data map M-必填
查询交易凭证图片结果 success boolean M-必填
错误码 errorCode string M-必填 该值应为UNKNOWN_ERROR:未知错误、TRANS_VOU_NOT_EXIST_ERROR:交易凭证不存在、SIGN_UNZIP_FAIL_ERROR:解压缩签名错误、SIGN_NOT_EXIST_ERROR:签名信息不存在、CREATE_TRANS_VOU_ERROr:生成交易凭证图片错误、MULTIPLE_VOU_ERROR:多笔交易凭证记录
错误枚举 transVouCreateError string M-必填
交易凭证图片 vouData string M-必填
图片格式 vouFormat string M-必填 jpg,png等
应用场景

POS电子凭条可用于消费交易(集中式商圈品牌连锁财务管理等场景POS电子凭条将签购单以电子化形式储存实现收单机构或商户对签购单的长期保管、备查。

应用对象

仅限机构用户、指定商户用户,开发者用户不可用。

接入流程

1.如需申请该API,请点击右上角“业务申请”,并认真填写相关内容;

2.待业务接口人审核通过后即可调用该API,审核周期约为2-3个工作日;

3.技术联调,可参照《“快速接入”产品API技术文档—接入指南》


应答码参照:
应答码 描述
0000 处理成功。
1001 接口未定义
1002 接口调用失败
1003 查询失败,交易开始日期距今大于1年
9901 您的IP(XXX.XXX.XXX.XXX)没有登记,请登录银联开放平台(https://open.unionpay.com/tjweb/user/info)进行白名单登记。
9902 您的IP(XXX.XXX.XXX.XXX)已被限制访问,请登录银联开放平台(open.unionpay.com)提交申诉请求。
9903 您的IP(XXX.XXX.XXX.XXX)请求过于频繁,已被临时限制,请5分钟后再尝试。
9904 您的 IP(XXX.XXX.XXX.XXX)不属于你设置的开发IP列表,请登录银联开放平台(open.unionpay.com)确认相关配置。
9905 请求参数值有误,请确认请求参数信息。
9906 您的账号不具备当前产品请求权限,如有权限,可重新获取该产品Token后再尝试。
9907 app_id与app_secret验证失败。
9908 您的Token已过期,请重新获取Token。
9909 您的Token信息非最新Token,请确保您的系统中使用的是最新的Token值。
9910 您的签名密钥未设置,请登录银联开放平台(https://open.unionpay.com/tjweb/user/info)确认相关配置。
9911 您的签名信息验证不通过,请检查您的签名实现是否符合银联开放平台(open.unionpay.com)提供的签名规则。
9912 您的报文格式有误,要求报文符合JSON数据格式。
9913 你的报文数据有误,未通过数据信息校验,具体原因视业务需求。
9914 您的报文无法解密,请检查您在银联开放平台(open.unionpay.com)上提供的RSA公钥是否正确。
9915 您的API调用额度已耗尽,需充值付费后补充调用额度。
9916 您的API并发调用额度已耗尽,需联系管理员调整您的并发限额。
9917 您的账号不具备当前产品API请求权限,请联系相关业务接口人。
9991 银联开放平台系统内部错误:产品服务调用失败。
9992 银联开放平台系统内部错误:产品服务系统未知错误
9993 银联开放平台系统内部错误:产品服务未注册至服务中心

1.报文举例-获取token:


请求URL:


https://openapi.unionpay.com/upapi/voucher/token?app_id=[value]&app_secret=[value]


 

应答JSON报文体

{
    "token": "abcdefghijklmn123456789",
    "expire_in": 7200
}



2.报文举例-交易信息查询接口



请求URL:


https://openapi.unionpay.com/upapi/voucher/queryPosVoucherListForMerchant?token=[token]&sign=[sign]&ts=[ts]



请求报文参数:


{

    "merchantCode": "111111111111111",
    "terminalId":"11111111",
    "priAccountNo":"6226091111111868",
    "startDate":"20180901",
    "endDate":"20180920",
    "start":"1",
    "pageSize":"10"
}


应答JSON报文体:


{
  
    "respCd":"0000"
    "respMsg": "接口调用成功", 
    "data": {
        "list" : [{
                    "id":"00000002",
                    "priAccountNo ":"622609******1868",
                    "transPosAt":"200",
                    "merchantCode":"111111111111111",
                    "terminalId":"11111111",
                    "terminalBatchNumber":"11111112",
                    "terminalSequence":"111112",
                    "paSettleDate":"20180901",
                    "transDate":"20180901",
                    "transDateTime":"111111",
                    },{…}
               ]
     }
}



3.报文举例-POS电子凭条生成接口


请求URL:


https://openapi.unionpay.com/upapi/voucher/createPosTransVoucher?token=[token]&sign=[sign]&ts=[ts]


请求报文参数:


{

    "transDate": "20180901",
    "id":"11111111"
}


应答JSON报文体:


{
  
    "respCd":"0000"
    "respMsg": "接口调用成功", 
    "data": {
                "success":"true",
                "errorCode ":"",
                "transVouCreateError":"",
                "vouData":"/9j/4AAQSkZJRgABAgAAAQABAAD/2wBDAAgGBgc",
                "vouFormat":"jpg"        
        
     }
}



1. “快速接入”产品API使用教程请参考在线文档:

“快速接入”产品API指南—接入指南


2. “快速接入”产品API安全调用过程请参考在线文档:

2.1“快速接入”产品API指南—获取产品token

2.2快速接入”产品API指南—产品功能接口调用


3. “快速接入”产品API接口调用报文签名样例请参考在线文档:

“快速接入”产品API指南—报文签名样例代码


4. “快速接入”产品API测试工具使用说明请参考在线文档:

“快速接入”产品API指南—“快速接入”测试工具



咨询我们
业务咨询
姓名: 刘蓓臻
电话: 0591-87870558
邮箱: bzliu@unionpay.com
技术咨询
姓名: 张昊
电话: 021-20633521
邮箱: zhanghao1@unionpay.com
热门推荐