IconCreated with Sketch.

YAPI 接口文档

YApi
  • 现金交易
    • 支付接口
    • 退款接口
  • 积分交易
    • 支付接口
    • 积分充值接口
    • 积分用户注册接口
    • 积分用户注销接口
    • 积分用户详情接口
    • 退款接口
  • 卡券交易
    • 卡券信息查询接口
    • 撤销已发卡券接口
    • 支付接口
    • 新增卡券批次(卡券包)接口
    • 查询卡券批次(卡券包)接口
    • 退款接口
  • 混合交易
    • 支付接口(现金+卡券)
    • 支付接口(现金+积分)
    • 退款接口(现金+卡券)
    • 退款接口(现金+积分)
  • 公共接口
    • 二维码生成接口
    • 支付异步回调接口
    • 查询接口
    • 退款异步回调接口

支付系统

支付系统接口文档

公共信息

一、项目说明

支付系统是一种基于Java语言开发的支付管理系统,旨在帮助个人实现安全、高效的支付处理和管理。系统集成了微信,支付宝,积分、银联、卡券支付,支持现金+非现金 组合支付 和 混合退款。
系统官方地址:http://paysys.uvstu.com/

二、签名生成规则

用户创建应用后,系统会自动生成签名key,签名加密的时候需要加入应用生成的签名key, 不同的应用签名key不一样。
本平台的签名统一使用MD5加密进行签名,签名规则为 MD5(签名key+请求参数+签名Key)
案例如下:

JSON参数:{"outTradeNo":"1234567890","goodName:":"商品兑换券","price":0.01} 签名KEY:12345678901234567890123456789012
加密数据拼接:12345678901234567890123456789012{"outTradeNo":"1234567890","goodName:":"商品兑换券","price":0.01}12345678901234567890123456789012

将以上加密数据拼接结果进行MD5加密即可生成签名
签名结果:3928173ab21128aa11cc225560594a12

三、枚举说明

支付渠道:channel

1 - 支付宝     2– 微信   3 – 积分  4 – 银联  5 – 卡券

支付类型:type

支付宝渠道:1 - 支付宝扫码支付    2 - 支付宝收银台支付   3 - 支付宝WAP支付
微信渠道:1 - 微信扫码支付
银联渠道:1 - 网关在线支付

订单状态:status

1 - 待支付中  2 - 支付成功  3 - 支付失败  4 - 待退款中  5 - 退款成功  6 - 退款失败

支付方式:payMethod

1 - 支付宝     2 - 微信    3 – 积分   4 - 银联   5 – 卡券  6-自定义 

卡券批次状态:status

1 – 未启用    2 – 已启用    3 – 已到期

卡券状态:status

1 – 未发出    2 – 已发出    3 – 已使用    4 – 已退回








现金交易

支付接口

基本信息

Path: /open/api/pay

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是
appid 1676056269929 是 应用ID
channel 1 是 支付渠道,详情请看Wiki
type 1 是 支付类型,详情请看Wiki
sign 123718923789173121 是 签名,详情请看Wiki

Body

名称类型是否必须默认值备注其他信息
outTradeNostring必须商户订单号
pricestring必须交易金额,单位:元
goodNamestring必须商品名称

返回数据

名称类型是否必须默认值备注其他信息
codeinteger必须状态码,成功-200 失败-500
messagestring必须信息描述,包括错误信息描述
isSucceedboolean必须业务是否请求成功,成功-true 失败-false
dataobject必须返回结果

退款接口

基本信息

Path: /open/api/refund

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是
appid 1676056269929 是 应用ID
sign 123718923789173121 是 签名,详情请看Wiki

Body

名称类型是否必须默认值备注其他信息
outTradeNostring必须商户订单号
refundMoneystring必须退款金额,单位:元
refundReasonstring必须退款原因

返回数据

名称类型是否必须默认值备注其他信息
codeinteger必须状态码,成功-200 失败-500
messagestring必须信息描述,包括错误信息描述
isSucceedboolean必须业务是否请求成功,成功-true 失败-false

积分交易

支付接口

基本信息

Path: /open/api/pay?1726817782356

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是
appid 1676056269929 是 应用ID
channel 1 是 支付渠道,详情请看Wiki
sign 123718923789173121 是 签名,详情请看Wiki

Body

名称类型是否必须默认值备注其他信息
outTradeNostring必须商户订单号
goodNamestring必须商品名称
userIdstring必须用户标识
socreinteger必须交易积分

返回数据

名称类型是否必须默认值备注其他信息
codeinteger必须状态码,成功-200 失败-500
messagestring必须信息描述,包括错误信息描述
isSucceedboolean必须业务是否请求成功,成功-true 失败-false
dataobject必须返回结果

积分充值接口

基本信息

Path: /open/api/socre/socreRecharge

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是
appid 1676056269929 是 应用 ID
sign 123718923789173121 是 签名,详情请看Wiki

Body

名称类型是否必须默认值备注其他信息
userIdstring必须用户ID
scoreinteger必须充值积分,充值范围1~10000000

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须状态码,成功-200 失败-500
messagestring非必须信息描述,包括错误信息描述
isSucceedboolean非必须业务是否请求成功,成功-true 失败-false
dataobject非必须积分用户数据
├─ userIdstring必须用户ID
├─ appidstring必须应用ID
├─ socrestring必须当前积分
├─ statusstring必须状态,正常-1 停用-2 注销-3

积分用户注册接口

基本信息

Path: /open/api/socre/regSocreUser

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是
appid 1676056269929 是 应用 ID
sign 123718923789173121 是 签名,详情请看Wiki

Body

名称类型是否必须默认值备注其他信息
userIdstring必须用户ID(用户唯一标识)

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须状态码,成功-200 失败-500
messagestring非必须信息描述,包括错误信息描述
isSucceedboolean非必须业务是否请求成功,成功-true 失败-false

积分用户注销接口

基本信息

Path: /open/api/socre/cancelSocreUser

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是
appid 1676056269929 是 应用 ID
sign 123718923789173121 是 签名,详情请看Wiki

Body

名称类型是否必须默认值备注其他信息
userIdstring必须用户ID

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须状态码,成功-200 失败-500
messagestring非必须信息描述,包括错误信息描述
isSucceedboolean非必须业务是否请求成功,成功-true 失败-false

积分用户详情接口

基本信息

Path: /open/api/socre/getSocreUser

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是
appid 1676056269929 是 应用 ID
sign 123718923789173121 是 签名,详情请看Wiki

Body

名称类型是否必须默认值备注其他信息
userIdstring必须用户ID

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须状态码,成功-200 失败-500
messagestring非必须信息描述,包括错误信息描述
isSucceedboolean非必须业务是否请求成功,成功-true 失败-false
dataobject非必须积分用户数据
├─ userIdstring必须用户ID
├─ appidstring必须应用ID
├─ socrestring必须当前积分
├─ statusstring必须状态,正常-1 停用-2 注销-3

退款接口

基本信息

Path: /open/api/refund?1726819392700

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是
appid 1676056269929 是 应用ID
sign 123718923789173121 是 签名,详情请看Wiki

Body

名称类型是否必须默认值备注其他信息
outTradeNostring必须商户订单号
refundSocreinteger必须退款积分
refundReasonstring必须退款原因

返回数据

名称类型是否必须默认值备注其他信息
codeinteger必须状态码,成功-200 失败-500
messagestring必须信息描述,包括错误信息描述
isSucceedboolean必须业务是否请求成功,成功-true 失败-false

卡券交易

卡券信息查询接口

基本信息

Path: /open/api/coupon/getCouponInfo

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是
appid 1676056269929 是 应用ID
sign 123718923789173121 是 签名,详情请看Wiki

Body

名称类型是否必须默认值备注其他信息
couponNostring必须卡券编号

返回数据

名称类型是否必须默认值备注其他信息
codeinteger必须状态码,成功-200 失败-500
messagestring必须信息描述,包括错误信息描述
isSucceedboolean必须业务是否请求成功,成功-true 失败-false
dataobject必须卡券数据信息
├─ idstring必须唯一ID
├─ couponBatchNostring必须卡券批次号
├─ couponNostring必须卡券编号
├─ statusinteger必须卡券状态,未发出-1 未使用-2 已使用-3 已退回-4
├─ createTimestring必须创建时间
├─ updateTimestring必须更新时间

撤销已发卡券接口

基本信息

Path: /open/api/coupon/cancelCoupon

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是
appid 1676056269929 是 应用ID
sign 123718923789173121 是 签名,详情请看Wiki

Body

名称类型是否必须默认值备注其他信息
couponNostring必须卡券编号

返回数据

名称类型是否必须默认值备注其他信息
codeinteger必须状态码,成功-200 失败-500
messagestring必须信息描述,包括错误信息描述
isSucceedboolean必须业务是否请求成功,成功-true 失败-false

支付接口

基本信息

Path: /open/api/pay?1726817799356

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是
appid 1676056269929 是 应用ID
channel 1 是 支付渠道,详情请看Wiki
sign 123718923789173121 是 签名,详情请看Wiki

Body

名称类型是否必须默认值备注其他信息
outTradeNostring必须商户订单号
goodNamestring必须商品名称
couponNostring必须卡券编号

返回数据

名称类型是否必须默认值备注其他信息
codeinteger必须状态码,成功-200 失败-500
messagestring必须信息描述,包括错误信息描述
isSucceedboolean必须业务是否请求成功,成功-true 失败-false
dataobject必须返回结果

新增卡券批次(卡券包)接口

基本信息

Path: /open/api/coupon/genCoupon

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是
appid 1676056269929 是 应用ID
sign 123718923789173121 是 签名,详情请看Wiki

Body

名称类型是否必须默认值备注其他信息
couponBatchNamestring必须批次名称
couponNumstring必须生成数量
couponRulestring必须自定义卡券规则
endTimestring必须卡券批次到期时间

返回数据

名称类型是否必须默认值备注其他信息
codeinteger必须状态码,成功-200 失败-500
messagestring必须信息描述,包括错误信息描述
isSucceedboolean必须业务是否请求成功,成功-true 失败-false
dataobject必须卡券数据信息
├─ idstring必须唯一ID
├─ appidstring必须关联应用ID
├─ couponBatchNostring必须卡券批次号
├─ couponBatchNamestring必须卡券批次名称
├─ couponNumstring必须卡券数量
├─ couponNotSentNumstring必须卡券未发数量
├─ couponSentNumstring必须卡券已发数量
├─ couponNotUsedNumstring必须卡券未使用数量
├─ couponUsedNumstring必须卡券已使用数量
├─ couponReturnNumstring必须卡券已退回数量
├─ couponRulestring必须卡券规则
├─ endTimestring必须到期时间
├─ statusstring必须批次状态,未启用-0 已启用-1 已过期-2
├─ createTimestring必须创建时间

查询卡券批次(卡券包)接口

基本信息

Path: /open/api/coupon/getCouponBatchInfo

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是
appid 1676056269929 是 应用ID
sign 123718923789173121 是 签名,详情请看Wiki

Body

名称类型是否必须默认值备注其他信息
couponBatchNostring必须卡券批次编号

返回数据

名称类型是否必须默认值备注其他信息
codeinteger必须状态码,成功-200 失败-500
messagestring必须信息描述,包括错误信息描述
isSucceedboolean必须业务是否请求成功,成功-true 失败-false
dataobject必须卡券数据信息
├─ idstring必须唯一ID
├─ appidstring必须关联应用ID
├─ couponBatchNostring必须卡券批次号
├─ couponBatchNamestring必须卡券批次名称
├─ couponNumstring必须卡券数量
├─ couponNotSentNumstring必须卡券未发数量
├─ couponSentNumstring必须卡券已发数量
├─ couponNotUsedNumstring必须卡券未使用数量
├─ couponUsedNumstring必须卡券已使用数量
├─ couponReturnNumstring必须卡券已退回数量
├─ couponRulestring必须卡券规则
├─ endTimestring必须到期时间
├─ statusstring必须批次状态,未启用-0 已启用-1 已过期-2
├─ createTimestring必须创建时间

退款接口

基本信息

Path: /open/api/refund?1726820011714

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是
appid 1676056269929 是 应用ID
sign 123718923789173121 是 签名,详情请看Wiki

Body

名称类型是否必须默认值备注其他信息
outTradeNostring必须商户订单号
refundCouponNostring必须卡券编号
refundReasonstring必须退款原因

返回数据

名称类型是否必须默认值备注其他信息
codeinteger必须状态码,成功-200 失败-500
messagestring必须信息描述,包括错误信息描述
isSucceedboolean必须业务是否请求成功,成功-true 失败-false

混合交易

支付接口(现金+卡券)

基本信息

Path: /open/api/pay?1726818480910

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是
appid 1676056269929 是 应用ID
channel 1,5 是 支付渠道,详情请看Wiki
type 1 是 支付类型,详情请看Wiki
sign 123718923789173121 是 签名,详情请看Wiki

Body

名称类型是否必须默认值备注其他信息
outTradeNostring必须商户订单号
pricestring必须交易金额,单位:元
goodNamestring必须商品名称
couponNostring必须卡券编号

返回数据

名称类型是否必须默认值备注其他信息
codeinteger必须状态码,成功-200 失败-500
messagestring必须信息描述,包括错误信息描述
isSucceedboolean必须业务是否请求成功,成功-true 失败-false
dataobject必须返回结果

支付接口(现金+积分)

基本信息

Path: /open/api/pay?1726818480039

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是
appid 1676056269929 是 应用ID
channel 1,3 是 支付渠道,详情请看Wiki
type 1 是 支付类型,详情请看Wiki
sign 123718923789173121 是 签名,详情请看Wiki

Body

名称类型是否必须默认值备注其他信息
outTradeNostring必须商户订单号
pricestring必须交易金额,单位:元
goodNamestring必须商品名称
userIdstring必须用户标识
socreinteger必须交易积分

返回数据

名称类型是否必须默认值备注其他信息
codeinteger必须状态码,成功-200 失败-500
messagestring必须信息描述,包括错误信息描述
isSucceedboolean必须业务是否请求成功,成功-true 失败-false
dataobject必须返回结果

退款接口(现金+卡券)

基本信息

Path: /open/api/refund?1726820291639

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是
appid 1676056269929 是 应用ID
sign 123718923789173121 是 签名,详情请看Wiki

Body

名称类型是否必须默认值备注其他信息
outTradeNostring必须商户订单号
refundMoneystring必须退款金额,单位:元
refundCouponNostring必须卡券编号
refundReasonstring必须退款原因

返回数据

名称类型是否必须默认值备注其他信息
codeinteger必须状态码,成功-200 失败-500
messagestring必须信息描述,包括错误信息描述
isSucceedboolean必须业务是否请求成功,成功-true 失败-false

退款接口(现金+积分)

基本信息

Path: /open/api/refund?1726820163013

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是
appid 1676056269929 是 应用ID
sign 123718923789173121 是 签名,详情请看Wiki

Body

名称类型是否必须默认值备注其他信息
outTradeNostring必须商户订单号
refundMoneystring必须退款金额,单位:元
refundSocreinteger必须退款积分
refundReasonstring必须退款原因

返回数据

名称类型是否必须默认值备注其他信息
codeinteger必须状态码,成功-200 失败-500
messagestring必须信息描述,包括错误信息描述
isSucceedboolean必须业务是否请求成功,成功-true 失败-false

公共接口

二维码生成接口

基本信息

Path: /open/api/getQrcode

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
url 是 支付宝微信的二维码url

Body

名称类型是否必须默认值备注其他信息
outTradeNostring必须商户订单号

返回数据

名称类型是否必须默认值备注其他信息

支付异步回调接口

基本信息

Path: /pay/xxxx

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
appidstring必须应用ID
outTradeNostring必须商户订单号
tradeNostring必须第三方订单号
refundNostring必须第三方退款单号
goodNamestring必须商品名称
payMethodstring必须支付方式
pricestring必须交易金额 单位:元
socrestring必须交易积分
couponNostring必须卡券编号
transactionTimestring必须交易时间
refundTimestring必须退款时间
statusstring必须订单状态
createTimestring必须创建时间

返回数据

名称类型是否必须默认值备注其他信息

查询接口

基本信息

Path: /open/api/query

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是
appid 1676056269929 是 应用ID
sign 123718923789173121 是 签名,详情请看Wiki

Body

名称类型是否必须默认值备注其他信息
outTradeNostring必须商户订单号

返回数据

名称类型是否必须默认值备注其他信息
codeinteger必须状态码,成功-200 失败-500
messagestring必须信息描述,包括错误信息描述
isSucceedboolean必须业务是否请求成功,成功-true 失败-false
dataobject必须返回结果
├─ appidstring必须应用ID
├─ userIdstring必须用户标识
├─ outTradeNostring必须商户订单号
├─ tradeNostring必须第三方订单号
├─ refundNostring必须第三方退款单号
├─ goodNamestring必须商品名称
├─ payMethodstring必须支付方式
├─ pricestring必须订单金额,单位:元
├─ socrestring必须订单积分
├─ couponNostring必须订单卡券
├─ transactionTimestring必须交易时间
├─ refundTimestring必须退款时间
├─ statusinteger必须订单状态
├─ createTimestring必须创建时间
├─ refundMoneystring必须已退金额
├─ refundSocrestring必须已退积分
├─ refundOrderNostring必须最新退款单号
├─ refundRecordobject必须退款记录

退款异步回调接口

基本信息

Path: /refund/xxxx

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
appidstring必须应用ID
outTradeNostring必须商户订单号
tradeNostring必须第三方订单号
refundNostring必须第三方退款单号
goodNamestring必须商品名称
payMethodstring必须支付方式
pricestring必须交易金额 单位:元
socrestring必须交易积分
couponNostring必须卡券编号
transactionTimestring必须交易时间
refundTimestring必须退款时间
statusstring必须订单状态
createTimestring必须创建时间
refundMoneystring必须已退金额
refundSocrestring必须已退积分
refundOrderNostring必须最新退款单号

返回数据

名称类型是否必须默认值备注其他信息

Build by YMFE.