银联小微资金服务产品

风控 信用评估 开发者 快速接入
银联小微商户资金服务产品是银联自主研发的,在多年消费大数据基础上,经过汇聚、处理、分析、挖掘形成的大数据服务产品。产品深度挖掘了用户消费数据的消费特征、行为特征,形成了基于卡片和持卡人两种层级的完整标签体系。在用户授权基础上,可为合规接入机构提供经脱敏的用户标签,为其风控、精准营销等提供支持。

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

API ID:328

接口状态:正常

业务申请
沙箱测试
沙箱调用

接口名称

获取token

接口描述

产品token是调用银联小微资金服务产品的全局唯一接口调用凭据,用户调用各接口时都需使用产品token。

接口地址

测试地址: https://openapi.unionpay.com/upapi/loanProdtest/token


生产地址: https://openapi.unionpay.com/upapi/loanProd/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://open.unionpay.com/upapi/loanProdtest/queryCdhdTransByCard


生产地址: https://openapi.unionpay.com/upapi/loanProd/queryCdhdTransByCard

请求方式

HTTP POST

请求url参数

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

请求报文体参数

名称 标识 字段类型 长度 请求要求 默认值 备注
融资平台机构代码 bankPlatCd string 11 M-必填 必须为开放平台登录机构号
持卡人证件号 certifId string 22 M-必填 持卡人身份证件号码
持卡人姓名 cdhdNm string 40 M-必填 持卡人姓名,最长40位,中文算2个字符
持卡人手机号 cdhdPhone string 20 O-选填 仅支持中国大陆的手机号,手机号不允许添加+86/86等
持卡人银行卡号 cardNo string 30 M-必填 持卡人的银行卡号
持卡人授权文件 cdhdZipFile string 60 O-选填 持卡人授权压缩zip文件 ,文件流转化为base64编码的字符串。 压缩文件包含持卡人本人签名的授权书的图片文件或电子文件、身份证影印件等文件,压缩打包成zip后文件大小控制在2M范围内
授权合同编号 signNo string 60 M-必填 授权合同编号

应答参数

名称 标识 字段类型 长度 请求要求 默认值 备注
持卡人银行卡号 cardNo string 30 O-选填 原样返回
融资平台机构代码 bankPlatCd string 11 M-必填 原样返回
响应信息 respMsg string 128 O-选填
响应编号 respCd string 4 M-必填 0000
响应数据 data map 128 O-选填 交易详情数据
卡号 cardNo string M-必填 银行卡号
卡类型 cardType string M-必填 卡类型:0 其它 1 借记卡 2 贷记卡 3 准贷记卡 4 借贷合一卡 5 预付费卡
卡等级 cardRank string M-必填 卡等级:0 不区分 1 普卡 2 金卡 3 白金卡 4 钻石卡
卡产品 cardProd string M-必填 卡产品:0 其它 1 公务卡 2 香港旅游卡 3 福农卡 4 旅游卡 5 商务卡 6 单位结算卡
最近认证时间 cardTime string M-必填
首笔交易日期 firstTransDt string M-必填 银行卡在银联网络内的首笔交易日期,格式为YYYYMMDD
银行卡月度交易信息 cdhdBankCardMonthTransList string M-必填
统计月份 transMonth string M-必填
交易笔数 transNum string M-必填
清算金额区间 settleAt string M-必填 清算金额区间(单位:分)
清算笔数 settleNum string M-必填
笔均清算金额 avgSettleAt string M-必填 笔均清算金额(单位:分)
交易失败占比 failureTransRt string M-必填
退货占比 refundRt string M-必填
单日最大消费笔数 maxConsumeTransNumSingleDay string M-必填
单日最大消费金额 maxConsumeTransAtSingleDay string M-必填 单日最大消费金额(单位:分)
交易渠道特征分布列表 transChnlDistributionDataList string M-必填
交易渠道 transChnl string M-必填 交易渠道:ol 线上消费;ofl 线下消费;trfer_in 转入;trfer_out 转出;withdrawal 取现;collection 代收;payment 代付
交易金额占比 transAtRt string M-必填
交易笔数占比 transNumRt string M-必填
交易分布特征列表 transDistributionDataList string M-必填
交易金额区间 transAtPeriod string M-必填 交易金额区间:0-0.5V;0.5V-0.7V;0.7V-0.9V;0.9V-V;V-1.1V;1.1V-1.3V;1.3V-1.5V;1.5V
消费金额占比 transAtRt string M-必填
消费笔数占比 transNumRt string M-必填
交易分时段交易统计列表 transPeriodStatisticsList string M-必填
统计时段 transPeriod string M-必填 统计时段:8am-14pm;14pm-18pm;18pm-22pm;22pm-8am
消费金额占比 transAtRt string M-必填
消费笔数占比 transNumRt string M-必填
最大单笔消费金额 maxSingleTransAt string M-必填 最大单笔消费金额(单位:分)
最小单笔消费金额 minSingleTransAt string M-必填 最小单笔消费金额(单位:分)
行业交易分布 industryTransDistributionDataList string M-必填
行业 industry string M-必填 详细取值说明将4.4章节
消费金额占比 transAtRt string M-必填
消费笔数占比 transNumRt string M-必填
境内城市分布 domesticTransDistributionDataList string M-必填
城市代码 city string M-必填
清算金额占比 transAtRt string M-必填
清算笔数占比 transNumRt string M-必填
交易发生的天数 transDays string M-必填
境外国家交易分布 abroadTransDistributionDataList string M-必填
国家代码 country string M-必填
清算金额占比 transAtRt string M-必填
清算笔数占比 transNumRt string M-必填
交易发生的天数 transDays string M-必填
持卡人重点交易商户分布 topTransMchntDistributionDataList string M-必填
排名 top string M-必填 排名,依次为1,2,3..,目前仅返回top1
商户中文简称 mchntCnNmAbbr string M-必填 商户中文简称(目前返回商户代码)
持卡人在该商户发生的消费金额占比 transAtRt string M-必填
持卡人在该商户发生的消费笔数占比 transNumRt string M-必填

接口名称

持卡人指标

接口描述

上送持卡人贷款授权信息

接口地址

测试地址: https://open.unionpay.com/upapi/loanProdtest/queryCdhdTransByMobile


生产地址: https://openapi.unionpay.com/upapi/loanProd/queryCdhdTransByMobile

请求方式

HTTP POST

请求url参数

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

请求报文体参数

名称 标识 字段类型 长度 请求要求 默认值 备注
融资平台机构代码 bankPlatCd string 11 M-必填 必须为开放平台登录机构号
持卡人证件号 certifId string 22 M-必填 持卡人身份证件号码
持卡人姓名 cdhdNm string 40 M-必填 持卡人姓名,最长40位,中文算2个字符
持卡人手机号 cdhdPhone string 20 M-必填 仅支持中国大陆的手机号,手机号不允许添加+86/86等
持卡人银行卡号 cardNo string 30 O-选填 持卡人的银行卡号
持卡人授权文件 cdhdZipFile string O-选填 持卡人授权压缩zip文件,文件流转化为base64编码的字符串。 压缩文件包含持卡人本人签名的授权书的图片文件或电子文件、身份证影印件等文件,压缩打包成zip后文件大小控制在2M范围内
授权合同编号 signNo string 60 M-必填 授权合同编号

应答参数

名称 标识 字段类型 长度 请求要求 默认值 备注
响应编号 respCd string 4 M-必填
响应信息 respMsg string 128 O-选填
融资平台机构代码 bankPlatCd string 11 O-选填 原样返回
持卡人银行卡号 cardNo string 30 O-选填 原样返回
响应数据 data map O-选填 交易详情数据
卡号 cardNo string M-必填 银行卡代号,依次为0,1,2…
卡类型 cardType string M-必填 卡类型:0 其它 ;1 借记卡;2 贷记卡;3 准贷记卡;4 借贷合一卡;5 预付费卡
卡等级 cardRank string M-必填 卡等级:0 不区分;1 普卡;2 金卡;3 白金卡;4 钻石卡
卡产品 cardProd string M-必填 卡产品:0 其它;1 公务卡;2 香港旅游卡;3 福农卡;4 旅游卡;5 商务卡;6 单位结算卡
最近认证时间 cardTime string M-必填 最近认证时间
首笔交易日期 firstTransDt string M-必填 银行卡在银联网络内的首笔交易日期,格式为YYYYMMDD
银行卡月度交易信息 cdhdBankCardMonthTransList string M-必填
统计月份 transMonth string M-必填
交易笔数 transNum string M-必填
清算金额区间 settleAt string M-必填 清算金额区间(单位:分)
清算笔数 settleNum string M-必填
笔均清算金额 avgSettleAt string M-必填 笔均清算金额(单位:分)
交易失败占比 failureTransRt string M-必填
退货占比 refundRt string M-必填
单日最大消费笔数 maxConsumeTransNumSingleDay string M-必填
单日最大消费金额 maxConsumeTransAtSingleDay string M-必填 单日最大消费金额(单位:分)
交易渠道特征分布列表 transChnlDistributionDataList string M-必填
交易渠道 transChnl string M-必填 交易渠道:ol 线上消费;ofl 线下消费;trfer_in 转入;trfer_out 转出;withdrawal 取现;collection 代收;payment 代付
交易金额占比 transAtRt string M-必填
交易笔数占比 transNumRt string M-必填
交易分布特征列表 transDistributionDataList string M-必填
交易金额区间 transAtPeriod string M-必填 交易金额区间:0-0.5V;0.5V-0.7V;0.7V-0.9V;0.9V-V;V-1.1V;1.1V-1.3V;1.3V-1.5V;1.5V
消费金额占比 transAtRt string M-必填
消费笔数占比 transNumRt string M-必填
交易分时段交易统计列表 transPeriodStatisticsList string M-必填
统计时段 transPeriod string M-必填 统计时段:8am-14pm;14pm-18pm;18pm-22pm;22pm-8am
消费金额占比 transAtRt string M-必填
消费笔数占比 transNumRt string M-必填
最大单笔消费金额 maxSingleTransAt string M-必填 最大单笔消费金额(单位:分)
最小单笔消费金额 minSingleTransAt string M-必填 最小单笔消费金额(单位:分)
行业交易分布 industryTransDistributionDataList string M-必填
行业 industry string M-必填 详细取值说明将4.4章节
消费金额占比 transAtRt string M-必填
消费笔数占比 transNumRt string M-必填
境内城市分布 domesticTransDistributionDataList string M-必填
城市代码 city string M-必填
清算金额占比 transAtRt string M-必填
清算笔数占比 transNumRt string M-必填
交易发生的天数 transDays string M-必填
境外国家交易分布 abroadTransDistributionDataList string M-必填
国家代码 country string M-必填
清算金额占比 transAtRt string M-必填
清算笔数占比 transNumRt string M-必填
交易发生的天数 transDays string M-必填
持卡人重点交易商户分布 topTransMchntDistributionDataList string M-必填
排名 top string M-必填 排名,依次为1,2,3..,目前仅返回top1
商户中文简称 mchntCnNmAbbr string M-必填 商户中文简称(目前返回商户代码)
持卡人在该商户发生的消费金额占比 transAtRt string M-必填
持卡人在该商户发生的消费笔数占比 transNumRt string M-必填
产品亮点

1、海量数据、深度挖掘

产品针对银联海量消费行为数据和人卡对应关系数据进行深度整合和挖掘,覆盖全量卡片和海量持卡人。具有覆盖人群广,刻画维度全,挖掘粒度深等特点。

2、自主对接调试

接入机构通过银联技术开放平台自主申请,自主调试,自助式完成技术对接,提升效率。

应用场景

信贷审批、信用卡审批、精准营销等。

应用对象

机构用户

接入流程

(一)   目前该产品API仅面向特定的金融机构和商户提供服务,如有相关需求,请发送邮件至业务接口人说明相关使用需求;

(二)   机构、商户以开发者用户注册申请产品,并请提供公司介绍、业务介绍材料以及产品使用场景;

(三)   技术联调,可参照技术开放平台在线文档《“快速接入”产品API指南-接入指南》

应答码参照:
应答码 描述
0000 处理成功。
0046 无效的测试卡号
0047 查询卡号失败
0048 未找到满足条件的卡号交易信息
1009 请求报文格式校验不通过
9901 您的IP(XXX.XXX.XXX.XXX)没有登记,请登录银联开放平台(open.unionpay.com)进行白名单登记。
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 您的签名密钥未设置,请登录银联开放平台(open.unionpay.com)确认相关配置
9911 您的签名信息验证不通过,请检查您的签名实现是否符合银联开放平台(open.unionpay.com)提供的签名规则。
9912 您的报文格式有误,要求报文符合JSON数据格式
9913 你的报文数据有误,未通过数据信息校验,具体原因视业务需求
9914 您的报文无法解密,请检查您在银联开放平台(open.unionpay.com)上提供的RSA公钥是否正确。
9917 您的账号不具备当前产品API请求权限,请联系相关业务接口人。
9991 银联开放平台系统内部错误:产品服务调用失败
9992 银联开放平台系统内部错误:产品服务系统未知错误
9993 银联开放平台系统内部错误:产品服务未注册至服务中心
9994 银联开放平台系统内部错误:产品服务参数错误

1.获取产品调用token信息

1.1JSON报文举例

请求URL:

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

应答JSON报文体:

{
    “token”: “”,
    “expire_in”:7200
}

2.卡片指标查询接口

2.1请求URL:

http请求方式,POST(请使用Https协议)

https://openapi.unionpay.com/upapi/loanProd/queryCdhdTransByCard?token=[value]&sign=[value]&ts=[value]

参数说明

参数

是否必填

说明

token

调用接口凭证,

sign

签名密钥secret

ts

请求时间戳

2.2请求报文说明

POST数据格式:JSON

POST报文示例:

{
    "bankPlatCd": "00010001",
    "certifId":"310123190001010001",
    "cdhdNm":"张三",
    "cdhdPhone":"13188888888",
    "cardNo":"6288888888888888",
    "cdhdZipFile":"ABCD1234ABCD1234……",
    "signNo":"1234567890ABCDEF1234567890ABCDEF"
}

2.3应答报文说明

调用失败时,银联会返回错误码等信息,JSON数据包示例如下:

{
    "respCd":"1009",
    "respMsg":"invalid request"
}

调用成功时,银联会返回满足条件的查询信息,此时JSON数据报文示例为:

图片2.png

3.持卡人指标查询接口

3.1请求URL

http请求方式,POST(请使用Https协议)

https://openapi.unionpay.com/upapi/loanProd/queryCdhdTransByMobile?token=[value]&sign=[value]&ts=[value]

参数说明:

参数

是否必填

说明

token

调用接口凭证

sign

签名密钥secret

ts

请求时间戳

3.2请求报文说明

POST数据格式:JSON

POST报文示例:

{
    "bankPlatCd": "00010001",
    "certifId":"310123190001010001",
    "cdhdNm":"张三",
    "cdhdPhone":"13188888888",
    "cardNo":"6288888888888888",
    "cdhdZipFile":"ABCD1234ABCD1234……",
    "signNo":"1234567890ABCDEF1234567890ABCDEF"
}

3.3应答报文说明

调用失败时,银联会返回错误码等信息,JSON数据包示例如下:

{
    "respCd":"1009",
    "respMsg":"invalid request"
}

调用成功时,银联会返回满足条件的查询信息,此时JSON数据报文示例为:

银联小微资金服务产品服务接口规范_V1.004895.png

行业代码

行业名称

air        

航空           

highway    

公路           

oil       

加油类         

railway   

铁路类         

rent     

租车类         

college   

大学学费       

preschool  

幼教消费       

school       

学校消费       

train        

培训消费       

beauty   

美容           

fitness  

运动健身       

ent_misc 

娱乐其它消费   

park    

游乐电玩       

rec     

娱乐休闲       

show     

文艺演出       

cash     

现金业务       

financing 

理财           

insurance 

保险           

decorate 

家装建材       

family   

家庭日常       

live_misc 

居住其它类     

new     

一手房消费     

resold   

二手房消费     

dinner   

餐厅           

food     

食品类         

book     

书籍音像类     

clo       

服装           

cosm      

化妆品         

depart     

百货商场       

digital    

电子数码       

elec     

家电           

gift    

礼品           

jewal   

珠宝工艺       

kidclo   

童装           

manclo    

男装           

shop_misc  

日常其它       

sport   

体育用品       

store   

便利店         

taxfree  

免税店         

wine    

烟酒           

womanclo  

女装           

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

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


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

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

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


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

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


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

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

相关文档

cardRsltV1.0.txt 更新时间:2018-08-02 08:56:00

mobileV1.0.txt 更新时间:2018-08-02 09:01:43