README.md

概述

EasyUnionPay 是一个开源的 银联云闪付小程序 非官方 SDK。
EasyUnionPay这可能是第一个支持composer导入的云闪付小程序开发包，小程序后端相关接口与支付相关接口已全部更新完毕。

使用环境

• php >= 5.6

接口方法🌈

模块名称	使用场景	接口方法
MiniProgram 小程序	BackendToken 获取应用访问令牌	getToken backendToken 是应用的服务端 API 的访问令牌，控制对服务端 API 的访问。backendToken 的有效期通过接口返回，目前设置为 7200 秒，接入方获取相应基础访问令牌后，需放入缓存，定期更新。
MiniProgram 小程序	BackendToken 获取应用访问令牌	getRefreshedToken 刷新并获取应用访问令牌backendToken
MiniProgram 小程序	AccessToken 获取授权访问令牌accessToken	getToken 获取用户授权访问令牌 accessToken , 经过用户授权完成后，可通过授权访问令牌调用对应权限可访问的服务端 API 。
MiniProgram 小程序	AccessToken 获取授权访问令牌accessToken	getRefreshedToken 刷新并获取授权访问令牌accessToken
MiniProgram 小程序	FrontToken 基础访问令牌	getToken 调用upsdk 的基础访问令牌
MiniProgram 小程序	FrontToken 基础访问令牌	getRefreshedToken 刷新并获取upsdk的基础访问令牌
MiniProgram 小程序	User 获取手用户机号	mobile 通过用户手机号授权 scope.mobile 完成后，通过该接口获取用户手机号。
MiniProgram 小程序	User 获取用户实名信息	auth 通过用户实名授权 scope.auth 完成后，通过该接口获取用户实名信息。
MiniProgram 小程序	User 获取用户绑定的银行卡列表（仅限银行小程序使用）	card 通过用户银行卡授权 scope.bank 完成后，银行小程序可获取用户绑定的该行银行卡列表信息。
MiniProgram 小程序	User 获取用户授权卡token	cardToken 通过用户授权卡 token scope.token ，获取用户授权指定卡 token 。
MiniProgram 小程序	User 查询用户状态	userStatus 通过该接口可判断用户当前状态
MiniProgram 小程序	Contract 申请签约	apply 无感支付签约接口，用户无感签约 scope:upapi_contract 授权且点击”同意授权”后，后台可通过此接口发起支付签约，签约完成后根据协议号走全渠道即可发起交易。
MiniProgram 小程序	Contract 申请解约	relieve 无感支付解约，使用接入方签约时传入的”签约协议号”，通过此接口可发起无感支付解约。
MiniProgram 小程序	Contract 签约关系查询	signStatus 查询用户与接入方的签约关系状态，5分钟缓存机制，为保证查询结果准确性，建议间隔5分钟以上再进行状态查询。
MiniProgram 小程序	Contract 未完成订单查询	unFinishedOrder 查询已签约用户在云闪付侧是否存在业务未完成的订单。
MiniProgram 小程序	Message 小程序模板消息	send 通过小程序运营平台配置小程序消息模板，通过该接口给云闪付用户推送小程序消息, 例如服务通知、动账通知。
MiniProgram 小程序	Secure 获取验证支付密码流水号	verifyPwd 获取验证支付密码流水号，用于唤起验证支付密码控件。
MiniProgram 小程序	Redpack 赠送专享红包	given 接入方给云闪付用户赠送专享红包。
MiniProgram 小程序	Redpack 机构账户（红包）余额查询	orgQuery 查询银联红包接入方账户余额查询。
MiniProgram 小程序	Redpack 专享红包余额查询	excQuery 根据专享红包活动 id 查询用户的该专享红包余额。
MiniProgram 小程序	Qual 抽奖资格赠送	given 接入方给云闪付用户赠送抽奖资格。
MiniProgram 小程序	Qual 抽奖资格查询	query 接入方查询云闪付用户的抽奖资格。
MiniProgram 小程序	Qual 抽奖	lotto 接入方通过资格赠送云闪付抽奖（红包/票券）接口资格，给用户赠送（非定额/定额）红包或者商城券。
MiniProgram 小程序	Qual 直接抽奖	directLotto 用于营销活动直接抽奖。
MiniProgram 小程序	Coupon 赠送优惠券	given 赠送优惠券接口，根据营销活动给云闪付用户赠送优惠券。
MiniProgram 小程序	Coupon 赠送优惠券结果查询	query 赠送优惠券结果查询。
MiniProgram 小程序	Coupon 优惠券活动剩余名额查询	quota 返回营销系统配置的优惠券活动剩余名额。
MiniProgram 小程序	Face 人脸识别	image 获取人脸识别照片
MiniProgram 小程序	Face 人脸识别	video 获取人脸识别视频
MiniProgram 小程序	Base 小程序初始化配置	config 获取初始化配置参数（可开启debug模式）
MiniProgram 小程序	Crypto 加解密	encrypt 3DES加密（加密信息）
MiniProgram 小程序	Crypto 加解密	decrypt 3DES解密（解密信息例如解密手机号）
MiniProgram 小程序	Crypto 加解密	verify 验签（银联公钥验签）
MiniProgram 小程序	Crypto 加解密	sign 签名(rsa私钥加签)
MiniProgram 小程序	Notify 小程序统一回调	unit 对消息通知进行统一处理
Payment 手机支付控件	Order 消费接口	pay 消费是指境内外持卡人在境内外商户网站进行购物等消费时用银行卡结算的交易，经批准的消费额将即时 地反映到该持卡人的账户余额上。(TN号获取)
Payment 手机支付控件	Order 消费撤销接口	cancel 是指因人为原因而撤销已完成的消费，商户可以通过SDK向银联全渠道支付平台发起消费撤销交易，消费撤销必须是撤销CUPS当日当批的消费。发卡行批准的消费撤销金额将即时地反映到该持卡人的账户上。完成交易的过程不需要同持卡人交互，属于后台交易。
Payment 手机支付控件	Order 退货接口	refund 在消费交易发生一段时间之内，由于持卡人或者商户的原因需要退款时，商户可以通过退货接口将支付款退还给持卡人，银联将在收到退货请求并且验证成功之后，按照退货规则让发卡行按照原路退到持卡人支付卡上。
Payment 手机支付控件	Order 交易状态查询接口	query 该接口提供所有银联订单的查询，包括支付、退货、消费撤销交易。商户可以通过查询订单接口主动查询订单状态，完成下一步的业务逻辑。
Payment 手机支付控件	Preorder 预授权接口	pay 预授权交易用于受理方向持卡人的发卡方确认交易许可。受理方将预估的消费金额作为预授权金额，发送给持卡人的发卡方。
Payment 手机支付控件	Preorder 预授权撤销	cancel 对已成功的POS预授权交易，在结算前使用预授权撤销交易，通知发卡方取消付款承诺。预授权撤销交易必须是对原始预授权交易或追加预授权交易最终承兑金额的全额撤销。
Payment 手机支付控件	Preorder 预授权完成撤销	refund 预授权完成撤销交易必须是对原始预授权完成交易的全额撤销。预授权完成撤销后的预授权仍然有效。
Payment 手机支付控件	Preorder 预授权完成	finish 对已批准的预授权交易，用预授权完成做支付结算。
Payment 手机支付控件	Notify 回调统一处理	unit 对消费接口，消费撤销接口，退货接口，预授权接口，预授权撤销接口，预授权完成接口，预授权完成撤销接口的回调统一处理
Payment 手机支付控件	Signature 加签验签	validate 对返回数据进行验签
Payment 手机支付控件	Signature 加签验签	sign 对发生数据进行加签
Payment 手机支付控件	File 文件传输类交易接口	download 商户可以通过此接口获取对账文件。
Payment 手机支付控件	File 文件保存方法	save 对获取的对账文件进行保存
Payment 手机支付控件	File 银联加密公钥更新查询接口（此接口暂时不可用，银联没详细文档）	updatePublicKey 商户定期（1天1次）向银联全渠道系统发起获取加密公钥信息交易。在加密公钥证书更新期间，全渠道系统支持新老证书的共同使用，新老证书并行期为1个月。全渠道系统向商户返回最新的加密公钥证书，由商户服务器替换本地证书。

项目地址

Github
码云

云闪付小程序技术交流群（如果二维码失效加我微信入群）

一起交流云闪付开发技术经验，不懂就问

项目作者

作者：cfn
邮箱：[email protected]
微信：SH-CFN

问题反馈

关于本文档中的内容问题（如错别字、示例错误、内容缺失等）以及需求建议，请统一至 leapy/unionpay 项目中提交 issue。

一经采纳，将会添加提交者信息至 参与贡献 列表当中以示感谢。

支持🌙

您的支持就是我们最大的动力，本项目接受任何形式的捐赠，您也可以star支持本项目。