IconCreated with Sketch.

YAPI 接口文档

YApi
  • 交易类
    • 下游行业应用日账单查询
    • 交易详情查询
    • 统一支付下单
    • 退款
    • 支付成功通知

支付入口

支付入口接口文档

交易类

下游行业应用日账单查询

基本信息

Path: /epay/order/daybill

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
startTime 是 20200310000000 账单查询-开始时间(以支付完成时间为准),格式为yyyyMMddHHmmss
endTime 是 20200310230000 账单查询-结束时间(以支付完成时间为准),格式为yyyyMMddHHmmss,与startTime必须为同一天,不允许跨日查询
merchantNo 是 55564c11ef0f457e82ff67dafd852663 口袋零钱商户编号
merchantLoginAccount 否 149757-004 口袋零钱收银员账号,merchantLoginAccount与merchantLoginNo二选一,同时存在时以merchantLoginNo优先,二者都不传默认查询所有该商户下所有订单
merchantLoginNo 否 41f302fb12f646db848254077c1476f5 口袋零钱收银员编号,merchantLoginAccount与merchantLoginNo二选一,同时存在时以merchantLoginNo优先,二者都不传默认查询所有该商户下所有订单
queryDetail 否 true、false 是否查询订单详情,默认为false
page 否 1 订单详情查询页数,不传默认为1
size 否 10 订单详情查询每页数据量,不传默认为10
version 是 1.0.0 版本号,固定传1.0.0
reqtime 是 20200423000000 接口请求时间,格式为yyyyMMddHHmmss
rancode 是 QKM2Q9 随机码,长度范围4~16
systemCode 是 99999 系统编号,口袋零钱分配
sign 是 34D61A35D302ADFB0890E307EFAB70F3 签名
payment 是 40022 支付服务商编号,口袋零钱分配

Body

名称类型是否必须默认值备注其他信息
startTimestring非必须
endTimestring非必须
merchantNostring非必须
queryDetailboolean非必须
pagenumber非必须
sizenumber非必须
merchantLoginNostring非必须
merchantLoginAccountstring非必须
versionstring非必须
reqtimestring非必须
rancodestring非必须
systemCodestring非必须
signstring非必须
paymentstring非必须

返回数据

名称类型是否必须默认值备注其他信息
codestring必须接口状态码
messagestring必须接口信息
signstring必须返回签名
dataobject非必须返回业务数据
├─ realIncomeAmountnumber非必须当日实收总额
├─ wxPayRealIncomeAmountnumber非必须当日微信实收总额
├─ unionPayRealIncomeAmountnumber非必须当日银联实收总额
├─ aliPayRealIncomeAmountnumber非必须当日支付宝实收总额
├─ tradeCountnumber非必须当日交易总笔数(含退款)
├─ settleAmountnumber非必须当日清算总额
├─ allMerchantTradeFeenumber非必须当日手续费总额
├─ totalPagenumber非必须订单详情总页数
├─ detailsobject []非必须订单详情(含退款),当请求参数queryDetail为ture时返回

item 类型: object

├─ payWayCodestring非必须支付方式编码:微信:weixin; 支付宝:alipay; 银联:unionpay
├─ payTypeCodestring非必须支付类型编码:wxPub:微信公众账号支付;wxPubQR:微信公众账号扫码支付;wxMicro:微信付款码支付;alipayH5:支付宝H5支付;alipayQR:支付宝扫码支付;alipayMicro:支付宝付款码支付,当被扫类型该字段可为空,后端根据authCode判断支付类型。wxApp:微信APP支付(未支持app支付)
├─ orderAmountnumber非必须订单金额
├─ orderTypestring非必须订单类型,已支付P,已退款R
├─ realIncomeAmountnumber非必须订单实收金额
├─ outTradeNostring非必须下游订单号
├─ orderIdstring非必须口袋零钱订单号
├─ outChannelNostring非必须上游订单号
├─ merchantTradeFeenumber非必须订单手续费
├─ orderTimestring非必须下单时间
├─ paySuccessTimestring非必须支付完成时间
├─ systemCodestring非必须订单所属系统号
├─ merchantLoginIdstring非必须收银员ID

交易详情查询

基本信息

Path: /epay/order/orderQuery

Method: GET

接口描述:

下单后可通过此接口查询订单状态及详细信息。

请求参数

Query

参数名称 是否必须 示例 备注
systemCode 是 99999 口袋零钱分配的系统编号
version 是 1.0.0 接口版本号,默认1.0.0
reqtime 是 20190110000000 接口请求时间,格式为yyyyMMddHHmmss
rancode 是 12dxaf3fa 6-16位随机字符串
merchantNo 是 口袋零钱系统分配的商户编号
outTradeNo 否 下游支付系统订单id,与outChannelNo二选一,推荐使用outChannelNo
outChannelNo 否 口袋零钱统一支付平台订单id,与outTradeNo二选一,推荐使用outChannelNo
sign 是

返回数据

名称类型是否必须默认值备注其他信息
codestring必须00标识接口处理结果,详见错误码定义列表

最大长度: 10

最小长度: 1

枚举: 00,01,02,03,99

undefined: @string

messagestring必须接口请求结果说明

undefined: @string

dataobject非必须
├─ outTradeNostring必须下游系统订单id
├─ outChannelNostring必须口袋零钱统一支付平台订单id
├─ payStatusstring必须订单状态 O:未支付 P:已支付 C:已取消 R:已退款 I:支付中 N:订单不存在 F:支付失败 T:订单超时

枚举: O,C,P,I,F,R,T

├─ orderTimestring必须下单时间
├─ transTimestring非必须交易成功时间
├─ realAmountnumber必须消费者实付金额

undefined: 1.00

├─ settleAmountnumber非必须清算金额

undefined: 1.00

├─ merchantNostring必须口袋零钱分配的商户编号

undefined: @string

├─ subAppidstring非必须渠道商或商户自己公众号appid
├─ subOpenidstring非必须消费者在渠道商或商户自己公众号appid下的openid
├─ userPaymentTypestring非必须消费者付款方式

undefined: DEBIT

├─ payTypeCodestring必须支付类型
├─ payWayCodestring必须支付方式
├─ attachstring非必须附加数据,在查询API和支付通知中原样返回,该字段主要用于商户携带订单的自定义数据
signstring必须签名

统一支付下单

基本信息

Path: /epay/order/unifiedOrder

Method: POST

接口描述:

下游系统通过此接口发起微信、支付宝扫码/公众号/刷卡/APP支付等。

请求参数

Headers

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

Body

名称类型是否必须默认值备注其他信息
systemCodestring必须40012口袋零钱分配的系统编号

最大长度: 10

最小长度: 5

undefined: @string

versionstring必须接口版本号,默认1.0.0

最大长度: 10

undefined: @string

reqtimestring必须接口请求时间,格式为yyyyMMddHHmmss

最大长度: 14

undefined: @string

rancodestring必须6-16位随机字符串

最大长度: 16

最小长度: 6

undefined: @string

payTypeCodestring必须支付类型编码:wxPub:微信公众账号支付;wxPubQR:微信公众账号扫码支付;wxMicro:微信付款码支付;alipayH5:支付宝H5支付;alipayQR:支付宝扫码支付;alipayMicro:支付宝付款码支付,当被扫类型该字段可为空,后端根据authCode判断支付类型。wxApp:微信APP支付(未支持app支付)。dynamicPay(口袋零钱自聚合动态码支付)

最大长度: 10

枚举: wxPub,wxPubQR,wxMicro,alipayH5,alipayQR,alipayMicro

paymentstring必须支付服务商编号(口袋零钱分配)
terminalTypestring必须ANDROID终端类型:ANDROID:安卓;IOS:苹果;WEB:PC或H5;OTHER:其他

最大长度: 10

枚举: ANDROID,IOS,WEB,OTHER

merchantLoginNostring必须收银员登录编号

最大长度: 32

merchantNostring必须口袋零钱分配的商户编号

最大长度: 32

notifyUrlstring非必须支付回调地址,支付类型为wxPub/wxPubQR/alipayH5/alipayQR/dynamicPay时必传

最大长度: 200

undefined: @url

outTradeNostring必须下游系统内部的订单号,32个字符内、可包含字母, 确保在商户系统唯一。推荐使用systemCode+yyyyMMddHHmmss+随机数字或字符串组成

最大长度: 32

最小长度: 10

currencystring非必须币种,默认人民币:CNY

undefined: CNY

amountnumber必须支付金额(元)

最大值: 999999

最小值: 0.01

undefined: 1

bodystring非必须商品或支付单简要描述
attachstring非必须附加数据,在查询API和支付通知中原样返回,该字段主要用于商户携带订单的自定义数据
timePaidstring非必须下游系统下单时间,格式为:yyyyMMddHHmmss
timeExpirestring非必须订单失效时间格式为:yyyyMMddHHmmss,不传默认为1分钟
authCodestring非必须消费者付款码,支付类型为wxMicro和alipayMicro时必填
subAppidstring非必须渠道商或商户公众号appid。支付类型为wxPub时必传
subOpenidstring非必须消费者在渠道商或商户公众号appid下的openid。支付类型为wxPub时必传
discountAmountnumber非必须折扣金额
userPocketAmountnumber非必须消费者红包金额
userPocketNostring非必须消费者红包编号
realAmountnumber必须消费者实付金额
callbackUrlstring非必须支付完成后跳转地址
signstring必须签名

最大长度: 32

undefined: @string

返回数据

名称类型是否必须默认值备注其他信息
codestring必须接口处理结果编码00:成功;01:失败;02:参数不合法;03:验签失败;99:系统错误;

枚举: 00,01,02,03,99

undefined: 00

messagestring必须接口处理结果描述

undefined: 成功

dataobject非必须仅当code=00时返回
├─ payParamsstring非必须当payTypeCode为wxPub、wxApp和alipayH5时返回,可用该字段报文调起收银台。如: wxPub "{"appId":"wxf5f08e6fd46598f9","nonceStr":"4nIlQV2bw6Kpdco3","package":"prepay_id=wx14160745036934f0d92bac3d1726975234","paySign":"6A14F0010975C58DA6738D28E5F2407F","signType":"MD5","timeStamp":"1534234065200"}" alipayH5 "{"tradeNo":"14160745036934f0d92bac3"}"
├─ codeUrlstring非必须动态二维码url链接地址,支付类型为wxQR/alipayQR/dynamicPay时返回

undefined: @url

├─ mweb_urlstring非必须微信H5支付返回连接,支付类型为wxH5时返回

undefined: @url

├─ outTradeNostring必须下游系统订单id
├─ outChannelNostring必须口袋零钱统一支付平台订单id
├─ amountnumber必须订单金额(元)

undefined: 1

├─ payCodestring必须支付确认码
├─ payStatusstring必须支付状态:O下单;I支付中;P已支付;F支付失败;T订单超时

undefined: O

signstring必须接口签名

退款

基本信息

Path: /epay/order/refund

Method: POST

接口描述:

支持100天以内订单退款(需事先配置特约商户退款时限长度)。
隔天退款时当日清算金额必须大于隔天退款金额,否则退款失败。

请求参数

Headers

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

Body

名称类型是否必须默认值备注其他信息
systemCodestring必须40012口袋零钱分配的系统编号

最大长度: 10

最小长度: 5

undefined: @string

versionstring必须接口版本号,默认1.0.0

最大长度: 10

undefined: @string

reqtimestring必须接口请求时间,格式为yyyyMMddHHmmss

最大长度: 14

undefined: @string

rancodestring必须6-16位随机字符串

最大长度: 16

最小长度: 6

undefined: @string

outChannelNostring非必须口袋零钱统一支付平台订单id,outChannelNo、outTradeNo、refundNo三选一,推荐使用outChannelNo
outTradeNostring非必须下游系统订单id,outChannelNo、outTradeNo、refundNo三选一,推荐使用outChannelNo
refundNostring非必须微信、支付宝订单详情里面的条形码商户订单编号,outChannelNo、outTradeNo、refundNo三选一,推荐使用outChannelNo
merchantNostring必须商户编号
loginNostring必须收银员编号(对应下单接口merchantLoginNo)
refundAmountstring必须退款金额
refundReasonstring非必须退款原因
passwordstring非必须收银员登录密码
signstring必须接口签名

返回数据

名称类型是否必须默认值备注其他信息
codestring必须返回码
messagestring必须返回消息
dataobject必须
├─ outTradeNostring必须商户平台订单id
├─ refundOrderNostring必须口袋零钱统一支付平台退款id
├─ merchantNostring必须口袋零钱分配的商户编号
├─ refundStatusstring必须退款状态,返回R即为退款成功
├─ refundReasonstring必须退款原因
├─ refundPersonstring必须退款人
├─ refundTimestring必须退款时间
├─ amountnumber必须退款金额
├─ payWayCodestring必须退款方式
signstring必须签名

支付成功通知

基本信息

Path: /epay/order/notify

Method: POST

接口描述:

此接口为下游自己编写,支付成功时口袋零钱回调此接口

请求参数

Headers

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

Body

名称类型是否必须默认值备注其他信息
systemCodestring必须口袋零钱分配的系统编号
versionstring必须接口版本号,默认1.0.0
reqtimestring必须接口请求时间,格式为yyyyMMddHHmmss
rancodestring必须6-16位随机字符串
merchantNostring必须口袋零钱分配的商户编号
outTradeNostring必须下游支付系统订单id
outChannelNostring必须口袋统一支付平台订单号
realAmountnumber必须消费者实付金额,单位元,保留小数点后两位
orderTimestring必须商户系统下单时间,格式为yyyyMMddHHmmss
transTimestring必须交易成功时间,格式为yyyyMMddHHmmss
attachstring非必须附加数据,在查询API和支付通知中原样返回,该字段主要用于商户携带订单的自定义数据
payStatusstring必须订单状态 O:未支付 P:已支付 C:已取消 R:已退款 I:支付中 N:订单不存在 F:支付失败 T:订单超时
payWayCodestring必须支付方式 微信:weixin 支付宝:alipay
subAppidstring非必须渠道商或商户公众号appid
subOpenidstring非必须消费者在渠道商或商户公众号appid下的openid
signstring必须签名

返回数据

名称类型是否必须默认值备注其他信息
codestring必须接口处理结果编码00:成功;01:失败;02:参数不合法;03:验签失败;99:系统错误;
messagestring必须接口请求结果说明
dataobject非必须
signstring必须签名

Build by YMFE.