| 程序包 | 说明 |
|---|---|
| cn.crushes.cloud.core.pay.wechat.v3 |
| 限定符和类型 | 方法和说明 |
|---|---|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatDiscountCardApi.addUserRecords(String outCardCode)
查询先享卡订单API
商户可以通过商户领卡号查询指定的先享卡,可用于对账或者界面展示。
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatDiscountCardApi.addUserRecords(UserRecordsParams params)
增加用户记录API
当用户在商户侧消费时,用户完成了微信先享卡的目标或者获取使用优惠时,商户需要把这个信息同步给微信先享卡平台,用于在微信先享卡小程序展示及先享卡到期后的用户结算。
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatCombinePayApi.appPay(CombinePayParams combinePayParams)
合单下单-APP支付API
使用合单支付接口,用户只输入一次密码,即可完成多个订单的支付。
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatPartnerPayApi.appPay(PartnerPayParams partnerPayParams)
APP下单API
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatDirectPayApi.appPay(PayParams payParams)
APP下单API
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatMarketingBusiFavorApi.associate(BusiFavorAssociateInfo associateInfo)
商家券关联订单信息API
将有效态(未核销)的商家券与订单信息关联,用于后续参与摇奖以及返佣激励等操作的统计。
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatBatchTransferApi.batchTransfer(CreateBatchTransferParams createBatchTransferParams)
发起批量转账API
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatMarketingBusiFavorApi.budget(BusiFavorBudgetParams params)
修改批次预算API
商户可以通过该接口修改批次单天发放上限数量或者批次最大发放数量
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatPayScoreApi.cancelServiceOrder(CancelServiceOrderParams params)
取消支付分订单API
微信支付分订单创建之后,由于某些原因导致订单不能正常支付时,可使用此接口取消订单。
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatPartnerPayApi.close(CloseTransParams closeTransParams)
关单API
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatCombinePayApi.close(CombineCloseParams combineCloseParams)
合单关闭订单API.
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatDirectPayApi.close(String outTradeNo)
关单API
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatPayScoreApi.completeServiceOrder(CompleteServiceOrderParams params)
完结支付分订单API
前置条件:服务订单状态为“进行中”且订单状态说明需为[USER_CONFIRM:用户确认]
完结微信支付分订单。
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatPayScoreApi.createServiceOrder(UserServiceOrderParams params)
创建支付分订单API
用户申请使用服务时,商户可通过此接口申请创建微信支付分订单。
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatMarketingBusiFavorApi.createStock(BusiFavorCreateParams params)
创建商家券券批次API
商家券介绍详见 微信支付商家券
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatMarketingFavorApi.createStock(StocksCreateParams params)
创建代金券批次API
通过调用此接口可创建代金券批次,包括 预充值 和 免充值 类型。
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatMarketingBusiFavorApi.deactivate(BusiFavorDeactivateParams params)
使券失效API
前置条件:券的状态为
CouponStatus.SENDED
商户可以通过该接口将可用券进行失效处理,券被失效后无法再被核销 |
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatPayScoreApi.directCompleteServiceOrder(DirectCompleteServiceOrderParams params)
创单结单合并API
相对需确认模式,免确认模式减少了用户确认授权这步操作,因此在免确认模式下商户无法获取用户的授权状态,为了解决商户的困扰,我们为免确认模式特别提供了查询授权状态和调起授权页面的api接口,这些接口仅在免确认模式下需要调用,且必须调用。
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatMarketingBusiFavorApi.disassociate(BusiFavorAssociateInfo associateInfo)
商家券取消关联订单信息API
取消商家券与订单信息的关联关系。
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatMarketingFavorApi.downloadStockRefundFlow(String stockId)
下载批次退款明细API
数据结果包含在响应体的 csv 字段中
可获取到某批次的退款明细数据,包括订单号、单品信息、银行流水号等,用于对账/数据分析。
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatMarketingFavorApi.downloadStockUseFlow(String stockId)
下载批次核销明细API
数据结果包含在响应体的 csv 字段中
可获取到某批次的核销明细数据,包括订单号、单品信息、银行流水号等,用于对账/数据分析。
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatMarketingBusiFavorApi.getCallbacks(String mchId)
查询商家券事件通知地址API
通过调用此接口可查询设置的通知URL。
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatCombinePayApi.h5Pay(CombineH5PayParams combineH5PayParams)
合单下单-H5支付API.
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatPartnerPayApi.h5Pay(PartnerPayParams partnerPayParams)
H5下单API
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatDirectPayApi.h5Pay(PayParams payParams)
H5下单API
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatCombinePayApi.jsPay(CombinePayParams combinePayParams)
合单下单-JSAPI支付/小程序支付API
使用合单支付接口,用户只输入一次密码,即可完成多个订单的支付。
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatPartnerPayApi.jsPay(PartnerPayParams partnerPayParams)
JSAPI/小程序下单API
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatDirectPayApi.jsPay(PayParams payParams)
JSAPI/小程序下单API
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatMarketingFavorApi.marketingImageUpload(org.springframework.web.multipart.MultipartFile file)
营销图片上传API
媒体图片只支持JPG、BMP、PNG格式,文件大小不能超过2M。
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatPayScoreApi.modifyServiceOrder(ModifyServiceOrderParams params)
修改订单金额API
完结订单总金额与实际金额不符时,可通过该接口修改订单金额。
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatCombinePayApi.nativePay(CombinePayParams combinePayParams)
合单下单-Native支付API.
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatPartnerPayApi.nativePay(PartnerPayParams partnerPayParams)
Native下单API
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatDirectPayApi.nativePay(PayParams payParams)
Native下单API
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatMarketingFavorApi.pauseStock(String stockId)
暂停代金券批次API
通过此接口可暂停指定代金券批次。
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatPayScoreApi.payServiceOrder(PayServiceOrderParams params)
商户发起催收扣款API
前置条件:服务订单支付状态处于“待支付”状态
当微信支付分订单支付状态处于“待支付”时,商户可使用该接口向用户发起收款。
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatPayScoreApi.permissions(ServiceOrderPermissionParams params)
商户预授权API
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatDiscountCardApi.preRequest(DiscountCardPreRequestParams params)
预受理领卡请求API
商户在引导用户跳转先享卡领卡前,需要请求先享卡预受理领卡请求接口,再根据返回数据引导用户跳转领卡。
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatBatchTransferApi.queryBatchByBatchId(QueryBatchTransferParams queryBatchTransferParams)
微信批次单号查询批次单API
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatBatchTransferApi.queryBatchByOutBatchNo(QueryBatchTransferParams queryBatchTransferParams)
微信批次单号查询批次单API
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatBatchTransferApi.queryBatchDetailByMch(QueryBatchTransferDetailParams queryBatchTransferDetailParams)
商家明细单号查询明细单API
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatBatchTransferApi.queryBatchDetailByWechat(QueryBatchTransferDetailParams queryBatchTransferDetailParams)
微信明细单号查询明细单API
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatMarketingFavorApi.queryCouponDetails(CouponDetailsQueryParams params)
查询代金券详情API
通过此接口可查询代金券信息,包括代金券的基础信息、状态。
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatMarketingFavorApi.queryMerchantsByStockId(MchQueryParams params)
查询代金券可用商户API
通过调用此接口可查询批次的可用商户号,判断券是否在某商户号可用,来决定是否展示。
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatPayScoreApi.queryPermissionsByAuthCode(PermissionsAuthCodeParams params)
查询与用户授权记录(授权协议号)API
通过authorization_code,商户查询与用户授权关系
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatPayScoreApi.queryPermissionsByOpenId(PermissionsOpenIdParams params)
查询与用户授权记录(openid)API
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatDirectPayApi.queryRefundInfo(String outRefundNo)
查询单笔退款API
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatPayScoreApi.queryServiceOrder(QueryServiceOrderParams params)
查询支付分订单API
用于查询单笔微信支付分订单详细信息。
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatMarketingBusiFavorApi.queryStockDetail(String stockId)
查询商家券详情API
商户可通过该接口查询已创建的商家券批次详情信息。
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatMarketingFavorApi.queryStockDetail(String stockId)
查询批次详情API
通过此接口可查询批次信息,包括批次的配置信息以及批次概况数据。
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatMarketingFavorApi.queryStockItems(MchQueryParams params)
查询代金券可用单品API
通过此接口可查询批次的可用商品编码,判断券是否可用于某些商品,来决定是否展示。
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatMarketingFavorApi.queryStocksByMch(StocksQueryParams params)
条件查询批次列表API
通过此接口可查询多个批次的信息,包括批次的配置信息以及批次概况数据。
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatPartnerPayApi.queryTransactionById(TransactionQueryParams params)
微信支付订单号查询API
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatDirectPayApi.queryTransactionById(TransactionQueryParams params)
微信支付订单号查询API
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatCombinePayApi.queryTransactionByOutTradeNo(String combineOutTradeNo)
合单查询订单API.
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatPartnerPayApi.queryTransactionByOutTradeNo(TransactionQueryParams params)
商户订单号查询API
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatDirectPayApi.queryTransactionByOutTradeNo(TransactionQueryParams params)
商户订单号查询API
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatMarketingBusiFavorApi.queryUserCoupon(UserBusiCouponQueryParams params)
查询用户单张券详情API
服务商可通过该接口查询微信用户卡包中某一张商家券的详情信息。
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatMarketingFavorApi.queryUserCouponsByMchId(UserCouponsQueryParams params)
根据商户号查用户的券API
可通过该接口查询用户在某商户号可用的全部券,可用于商户的小程序/H5中,用户"我的代金券"或"提交订单页"展示优惠信息。
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatMarketingBusiFavorApi.queryUserStocks(UserBusiFavorQueryParams params)
根据过滤条件查询用户券API
商户自定义筛选条件(如创建商户号、归属商户号、发放商户号等),查询指定微信用户卡包中满足对应条件的所有商家券信息。
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatBatchTransferApi.receiptBill(String outBatchNo)
转账电子回单申请受理API
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatMarketingBusiFavorApi.refund(BusiFavorRefundParams params)
申请退券API
商户可以通过该接口为已核销的券申请退券
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatDirectPayApi.refund(RefundParams refundParams)
申请退款API
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatMarketingFavorApi.restartStock(String stockId)
重启代金券批次API
通过此接口可重启指定代金券批次。
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatMarketingFavorApi.sendCouponsCard(CouponsCardSendParams params)
发放消费卡API
商户通过调用本接口向用户发放消费卡,用户领到卡的同时会领取到一批代金券,消费卡会自动放入卡包中。
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatMarketingFavorApi.sendStock(StocksSendParams params)
发放代金券API
商户侧开发时建议增加发放流水记录。
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatMarketingBusiFavorApi.setCallbacks(BusiFavorCallbackSettingParams params)
设置商家券事件通知地址API
用于设置接收商家券相关事件通知的URL,可接收商家券相关的事件通知、包括发放通知等。
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatMarketingFavorApi.setMarketingFavorCallback(String notifyUrl)
代金券核销回调通知API。
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatMarketingFavorApi.startStock(String stockId)
激活代金券批次API
制券成功后,通过调用此接口激活批次,如果是预充值代金券,激活时会从商户账户余额中锁定本批次的营销资金。
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatPayScoreApi.syncServiceOrder(SyncServiceOrderParams params)
同步服务订单信息API
前提条件:同步商户渠道收款成功信息时,即场景类型=“Order_Paid”,订单的状态需为[MCH_COMPLETE:商户完结订单]
由于收款商户进行的某些“线下操作”会导致微信支付侧的订单状态与实际情况不符。
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatPayScoreApi.terminatePermissionsByAuthCode(PermissionsAuthCodeParams params)
解除用户授权关系(授权协议号)API
通过authorization_code,商户解除用户授权关系
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatPayScoreApi.terminatePermissionsByOpenId(PermissionsOpenIdParams params)
解除用户授权关系(openid)API
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatMarketingBusiFavorApi.updateStock(BusiFavorUpdateParams params)
修改商家券基本信息API
商户可以通过该接口修改商家券基本信息
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatMarketingBusiFavorApi.uploadCouponCodes(BusiCouponCodeUploadParams params)
上传预存code API
商家券的Code码可由微信后台随机分配,同时支持商户自定义。
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatMarketingBusiFavorApi.use(BusiFavorUseParams params)
核销用户券API,暂时appid需要手工在参数中传递
在用户满足优惠门槛后,服务商可通过该接口核销用户微信卡包中具体某一张商家券。
|
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> |
WechatPayScoreApi.userServiceState(UserServiceStateParams params)
微信支付分-查询用户授权状态API.
|
Copyright © 2021. All rights reserved.