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
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
startTime | string | 非必须 | |||
endTime | string | 非必须 | |||
merchantNo | string | 非必须 | |||
queryDetail | boolean | 非必须 | |||
page | number | 非必须 | |||
size | number | 非必须 | |||
merchantLoginNo | string | 非必须 | |||
merchantLoginAccount | string | 非必须 | |||
version | string | 非必须 | |||
reqtime | string | 非必须 | |||
rancode | string | 非必须 | |||
systemCode | string | 非必须 | |||
sign | string | 非必须 | |||
payment | string | 非必须 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | string | 必须 | 接口状态码 | ||
message | string | 必须 | 接口信息 | ||
sign | string | 必须 | 返回签名 | ||
data | object | 非必须 | 返回业务数据 | ||
├─ realIncomeAmount | number | 非必须 | 当日实收总额 | ||
├─ wxPayRealIncomeAmount | number | 非必须 | 当日微信实收总额 | ||
├─ unionPayRealIncomeAmount | number | 非必须 | 当日银联实收总额 | ||
├─ aliPayRealIncomeAmount | number | 非必须 | 当日支付宝实收总额 | ||
├─ tradeCount | number | 非必须 | 当日交易总笔数(含退款) | ||
├─ settleAmount | number | 非必须 | 当日清算总额 | ||
├─ allMerchantTradeFee | number | 非必须 | 当日手续费总额 | ||
├─ totalPage | number | 非必须 | 订单详情总页数 | ||
├─ details | object [] | 非必须 | 订单详情(含退款),当请求参数queryDetail为ture时返回 | item 类型: object | |
├─ payWayCode | string | 非必须 | 支付方式编码:微信:weixin; 支付宝:alipay; 银联:unionpay | ||
├─ payTypeCode | string | 非必须 | 支付类型编码:wxPub:微信公众账号支付;wxPubQR:微信公众账号扫码支付;wxMicro:微信付款码支付;alipayH5:支付宝H5支付;alipayQR:支付宝扫码支付;alipayMicro:支付宝付款码支付,当被扫类型该字段可为空,后端根据authCode判断支付类型。wxApp:微信APP支付(未支持app支付) | ||
├─ orderAmount | number | 非必须 | 订单金额 | ||
├─ orderType | string | 非必须 | 订单类型,已支付P,已退款R | ||
├─ realIncomeAmount | number | 非必须 | 订单实收金额 | ||
├─ outTradeNo | string | 非必须 | 下游订单号 | ||
├─ orderId | string | 非必须 | 口袋零钱订单号 | ||
├─ outChannelNo | string | 非必须 | 上游订单号 | ||
├─ merchantTradeFee | number | 非必须 | 订单手续费 | ||
├─ orderTime | string | 非必须 | 下单时间 | ||
├─ paySuccessTime | string | 非必须 | 支付完成时间 | ||
├─ systemCode | string | 非必须 | 订单所属系统号 | ||
├─ merchantLoginId | string | 非必须 | 收银员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 | 是 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | string | 必须 | 00 | 标识接口处理结果,详见错误码定义列表 | 最大长度: 10 最小长度: 1 枚举: 00,01,02,03,99 undefined: @string |
message | string | 必须 | 接口请求结果说明 | undefined: @string | |
data | object | 非必须 | |||
├─ outTradeNo | string | 必须 | 下游系统订单id | ||
├─ outChannelNo | string | 必须 | 口袋零钱统一支付平台订单id | ||
├─ payStatus | string | 必须 | 订单状态 O:未支付 P:已支付 C:已取消 R:已退款 I:支付中 N:订单不存在 F:支付失败 T:订单超时 | 枚举: O,C,P,I,F,R,T | |
├─ orderTime | string | 必须 | 下单时间 | ||
├─ transTime | string | 非必须 | 交易成功时间 | ||
├─ realAmount | number | 必须 | 消费者实付金额 | undefined: 1.00 | |
├─ settleAmount | number | 非必须 | 清算金额 | undefined: 1.00 | |
├─ merchantNo | string | 必须 | 口袋零钱分配的商户编号 | undefined: @string | |
├─ subAppid | string | 非必须 | 渠道商或商户自己公众号appid | ||
├─ subOpenid | string | 非必须 | 消费者在渠道商或商户自己公众号appid下的openid | ||
├─ userPaymentType | string | 非必须 | 消费者付款方式 | undefined: DEBIT | |
├─ payTypeCode | string | 必须 | 支付类型 | ||
├─ payWayCode | string | 必须 | 支付方式 | ||
├─ attach | string | 非必须 | 附加数据,在查询API和支付通知中原样返回,该字段主要用于商户携带订单的自定义数据 | ||
sign | string | 必须 | 签名 |
Path: /epay/order/unifiedOrder
Method: POST
接口描述:
下游系统通过此接口发起微信、支付宝扫码/公众号/刷卡/APP支付等。
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
systemCode | string | 必须 | 40012 | 口袋零钱分配的系统编号 | 最大长度: 10 最小长度: 5 undefined: @string |
version | string | 必须 | 接口版本号,默认1.0.0 | 最大长度: 10 undefined: @string | |
reqtime | string | 必须 | 接口请求时间,格式为yyyyMMddHHmmss | 最大长度: 14 undefined: @string | |
rancode | string | 必须 | 6-16位随机字符串 | 最大长度: 16 最小长度: 6 undefined: @string | |
payTypeCode | string | 必须 | 支付类型编码:wxPub:微信公众账号支付;wxPubQR:微信公众账号扫码支付;wxMicro:微信付款码支付;alipayH5:支付宝H5支付;alipayQR:支付宝扫码支付;alipayMicro:支付宝付款码支付,当被扫类型该字段可为空,后端根据authCode判断支付类型。wxApp:微信APP支付(未支持app支付)。dynamicPay(口袋零钱自聚合动态码支付) | 最大长度: 10 枚举: wxPub,wxPubQR,wxMicro,alipayH5,alipayQR,alipayMicro | |
payment | string | 必须 | 支付服务商编号(口袋零钱分配) | ||
terminalType | string | 必须 | ANDROID | 终端类型:ANDROID:安卓;IOS:苹果;WEB:PC或H5;OTHER:其他 | 最大长度: 10 枚举: ANDROID,IOS,WEB,OTHER |
merchantLoginNo | string | 必须 | 收银员登录编号 | 最大长度: 32 | |
merchantNo | string | 必须 | 口袋零钱分配的商户编号 | 最大长度: 32 | |
notifyUrl | string | 非必须 | 支付回调地址,支付类型为wxPub/wxPubQR/alipayH5/alipayQR/dynamicPay时必传 | 最大长度: 200 undefined: @url | |
outTradeNo | string | 必须 | 下游系统内部的订单号,32个字符内、可包含字母, 确保在商户系统唯一。推荐使用systemCode+yyyyMMddHHmmss+随机数字或字符串组成 | 最大长度: 32 最小长度: 10 | |
currency | string | 非必须 | 币种,默认人民币:CNY | undefined: CNY | |
amount | number | 必须 | 支付金额(元) | 最大值: 999999 最小值: 0.01 undefined: 1 | |
body | string | 非必须 | 商品或支付单简要描述 | ||
attach | string | 非必须 | 附加数据,在查询API和支付通知中原样返回,该字段主要用于商户携带订单的自定义数据 | ||
timePaid | string | 非必须 | 下游系统下单时间,格式为:yyyyMMddHHmmss | ||
timeExpire | string | 非必须 | 订单失效时间格式为:yyyyMMddHHmmss,不传默认为1分钟 | ||
authCode | string | 非必须 | 消费者付款码,支付类型为wxMicro和alipayMicro时必填 | ||
subAppid | string | 非必须 | 渠道商或商户公众号appid。支付类型为wxPub时必传 | ||
subOpenid | string | 非必须 | 消费者在渠道商或商户公众号appid下的openid。支付类型为wxPub时必传 | ||
discountAmount | number | 非必须 | 折扣金额 | ||
userPocketAmount | number | 非必须 | 消费者红包金额 | ||
userPocketNo | string | 非必须 | 消费者红包编号 | ||
realAmount | number | 必须 | 消费者实付金额 | ||
callbackUrl | string | 非必须 | 支付完成后跳转地址 | ||
sign | string | 必须 | 签名 | 最大长度: 32 undefined: @string |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | string | 必须 | 接口处理结果编码00:成功;01:失败;02:参数不合法;03:验签失败;99:系统错误; | 枚举: 00,01,02,03,99 undefined: 00 | |
message | string | 必须 | 接口处理结果描述 | undefined: 成功 | |
data | object | 非必须 | 仅当code=00时返回 | ||
├─ payParams | string | 非必须 | 当payTypeCode为wxPub、wxApp和alipayH5时返回,可用该字段报文调起收银台。如: wxPub "{"appId":"wxf5f08e6fd46598f9","nonceStr":"4nIlQV2bw6Kpdco3","package":"prepay_id=wx14160745036934f0d92bac3d1726975234","paySign":"6A14F0010975C58DA6738D28E5F2407F","signType":"MD5","timeStamp":"1534234065200"}" alipayH5 "{"tradeNo":"14160745036934f0d92bac3"}" | ||
├─ codeUrl | string | 非必须 | 动态二维码url链接地址,支付类型为wxQR/alipayQR/dynamicPay时返回 | undefined: @url | |
├─ mweb_url | string | 非必须 | 微信H5支付返回连接,支付类型为wxH5时返回 | undefined: @url | |
├─ outTradeNo | string | 必须 | 下游系统订单id | ||
├─ outChannelNo | string | 必须 | 口袋零钱统一支付平台订单id | ||
├─ amount | number | 必须 | 订单金额(元) | undefined: 1 | |
├─ payCode | string | 必须 | 支付确认码 | ||
├─ payStatus | string | 必须 | 支付状态:O下单;I支付中;P已支付;F支付失败;T订单超时 | undefined: O | |
sign | string | 必须 | 接口签名 |
Path: /epay/order/refund
Method: POST
接口描述:
支持100天以内订单退款(需事先配置特约商户退款时限长度)。
隔天退款时当日清算金额必须大于隔天退款金额,否则退款失败。
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
systemCode | string | 必须 | 40012 | 口袋零钱分配的系统编号 | 最大长度: 10 最小长度: 5 undefined: @string |
version | string | 必须 | 接口版本号,默认1.0.0 | 最大长度: 10 undefined: @string | |
reqtime | string | 必须 | 接口请求时间,格式为yyyyMMddHHmmss | 最大长度: 14 undefined: @string | |
rancode | string | 必须 | 6-16位随机字符串 | 最大长度: 16 最小长度: 6 undefined: @string | |
outChannelNo | string | 非必须 | 口袋零钱统一支付平台订单id,outChannelNo、outTradeNo、refundNo三选一,推荐使用outChannelNo | ||
outTradeNo | string | 非必须 | 下游系统订单id,outChannelNo、outTradeNo、refundNo三选一,推荐使用outChannelNo | ||
refundNo | string | 非必须 | 微信、支付宝订单详情里面的条形码商户订单编号,outChannelNo、outTradeNo、refundNo三选一,推荐使用outChannelNo | ||
merchantNo | string | 必须 | 商户编号 | ||
loginNo | string | 必须 | 收银员编号(对应下单接口merchantLoginNo) | ||
refundAmount | string | 必须 | 退款金额 | ||
refundReason | string | 非必须 | 退款原因 | ||
password | string | 非必须 | 收银员登录密码 | ||
sign | string | 必须 | 接口签名 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | string | 必须 | 返回码 | ||
message | string | 必须 | 返回消息 | ||
data | object | 必须 | |||
├─ outTradeNo | string | 必须 | 商户平台订单id | ||
├─ refundOrderNo | string | 必须 | 口袋零钱统一支付平台退款id | ||
├─ merchantNo | string | 必须 | 口袋零钱分配的商户编号 | ||
├─ refundStatus | string | 必须 | 退款状态,返回R即为退款成功 | ||
├─ refundReason | string | 必须 | 退款原因 | ||
├─ refundPerson | string | 必须 | 退款人 | ||
├─ refundTime | string | 必须 | 退款时间 | ||
├─ amount | number | 必须 | 退款金额 | ||
├─ payWayCode | string | 必须 | 退款方式 | ||
sign | string | 必须 | 签名 |
Path: /epay/order/notify
Method: POST
接口描述:
此接口为下游自己编写,支付成功时口袋零钱回调此接口
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
systemCode | string | 必须 | 口袋零钱分配的系统编号 | ||
version | string | 必须 | 接口版本号,默认1.0.0 | ||
reqtime | string | 必须 | 接口请求时间,格式为yyyyMMddHHmmss | ||
rancode | string | 必须 | 6-16位随机字符串 | ||
merchantNo | string | 必须 | 口袋零钱分配的商户编号 | ||
outTradeNo | string | 必须 | 下游支付系统订单id | ||
outChannelNo | string | 必须 | 口袋统一支付平台订单号 | ||
realAmount | number | 必须 | 消费者实付金额,单位元,保留小数点后两位 | ||
orderTime | string | 必须 | 商户系统下单时间,格式为yyyyMMddHHmmss | ||
transTime | string | 必须 | 交易成功时间,格式为yyyyMMddHHmmss | ||
attach | string | 非必须 | 附加数据,在查询API和支付通知中原样返回,该字段主要用于商户携带订单的自定义数据 | ||
payStatus | string | 必须 | 订单状态 O:未支付 P:已支付 C:已取消 R:已退款 I:支付中 N:订单不存在 F:支付失败 T:订单超时 | ||
payWayCode | string | 必须 | 支付方式 微信:weixin 支付宝:alipay | ||
subAppid | string | 非必须 | 渠道商或商户公众号appid | ||
subOpenid | string | 非必须 | 消费者在渠道商或商户公众号appid下的openid | ||
sign | string | 必须 | 签名 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | string | 必须 | 接口处理结果编码00:成功;01:失败;02:参数不合法;03:验签失败;99:系统错误; | ||
message | string | 必须 | 接口请求结果说明 | ||
data | object | 非必须 | |||
sign | string | 必须 | 签名 |