Appearance
分账信息通知 ¶
通知方式 ¶
参数 | 说明 |
---|---|
请求方式 | POST |
请求类型 | application/json |
客户系统应答值 | 大写 SUCCESS 字符串 |
通知规则 ¶
当满足下列通知时机时,系统会将支付订单状态变化通知到商户的接收地址上。商户需要接收处理该消息并返回应答。
如果收到客户系统的应答不符合规范或超时,支付网关会认为通知失败,并通过一定的策略定期重新发起通知,尽可能提高通知的成功率,但不保证通知最终能成功。 (通知频率为15s/15s/30s/3m/10m/20m/30m/30m/30m/60m/3h/3h/3h/6h/6h
- 总计 24h4m)
通知时机 ¶
当分账订单状态发生变化时,系统会主动将支付订单状态变化通知到商户的接收地址上
分账状态 | 描述 | 是否通知 |
---|---|---|
分账开始 | ||
分账成功 | ||
分账结束 | ||
分账失败 |
注意事项 ¶
- 回调地址必须可被支付网关访问
- 回调地址仅支持http与https协议
- 如果要对回调消息验签,参照签名规则文档进行验签
通知参数 ¶
字段名 | 变量名 | 必传 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
支付订单号 | orderNo | 是 | String | 1753370980523384832 | 系统生成的订单号 |
商户支付订单号 | bizOrderNo | 是 | String | P0001 | 商户传输的订单号 |
通道支付订单号 | outOrderNo | 是 | String | 22212137757334130130 | 三方支付系统返回的交易号 |
标题 | title | 是 | String | 测试支付 | |
描述 | description | 否 | String | 测试描述 | |
支持分账 | allocation | 否 | Boolean | true | 订单是都支持分账 |
自动分账 | description | 否 | Boolean | false | 是否开启自动分账 |
支付通道 | autoAllocation | 是 | String | wechat_pay | |
支付方式 | method | 是 | String | qrcode | |
金额 | amount | 是 | int | 20 | 订单支付的金额 |
可退款余额 | refundableBalance | 是 | int | 18 | 剩余可以进行退款的余额 |
支付状态 | status | 是 | String | progress | 见PayStatusEnum说明 |
分账状态 | allocationStatus | 是 | String | progress | 见PayOrderAllocStatusEnum说明 |
支付时间 | payTime | 否 | Long | 114454145 | 使用时间戳(秒级) |
过期时间 | expiredTime | 是 | Long | 1454412354 | 使用时间戳(秒级) |
关闭时间 | closeTime | 是 | Long | 1454412354 | 使用时间戳(秒级) |
商户扩展参数 | attach | 是 | String | "{data:1234}" | 回调时会原样返回 |
错误码(订单) | errorCode | 否 | Integer | 0 | 与状态码(公共)不同,这里返回的是支付订单的错误状态 |
错误信息(订单) | errorCode | 否 | String | 未启用分账 | 与错误信息(公共),这里返回的是支付订单的错误信息提示 |
签名 | sign | 是 | String | 072695d112892e382a7093b81e6a52af | |
状态码(公共) | code | 否 | Integer | 0 | 为0表示成功,非0表示失败 |
错误信息(公共) | msg | 否 | String | 关闭失败 | 状态非0时会有返回值 |
响应时间(公共) | resTime | 是 | Long | 123123121 | 服务返回请求的时间,时间戳(秒级) |
通知示例 ¶
json
{
"code": 0,
"msg": null,
"resTime": 1715867600,
"sign": "896ba894d50f47670558975bec6646af3e4a7d334b1e27f1ff7788b4c9a12a62",
"bizOrderNo": "P1715867447234",
"orderNo": "DEVP24051621525063000002",
"outOrderNo": "22240516788144804521",
"title": "测试支付",
"description": null,
"allocation": false,
"autoAllocation": null,
"channel": "union_pay",
"method": "qrcode",
"amount": 10000,
"refundableBalance": 10000,
"status": "success",
"allocationStatus": null,
"payTime": 1715867570,
"expiredTime": 1715869370,
"closeTime": null,
"attach": "{回调参数}",
"errorCode": null,
"errorMsg": null
}
通知接收 ¶
可以使用SDK对接收到的通知内容进行反序列和验签,简化消息通知的处理流程。可以使用
PayNoticeModel
支付通知实体类来接收数据,使用PaySignUtil进行验签
接收 ¶
java
package org.dromara.daxpay.single.demo.controller;
import cn.bootx.platform.common.core.annotation.IgnoreAuth;
import org.dromara.daxpay.single.sdk.model.notice.PayNoticeModel;
import org.dromara.daxpay.single.sdk.model.notice.RefundNoticeModel;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import java.util.Map;
/**
*
* @author xxm
* @since 2024/2/24
*/
@Slf4j
@IgnoreAuth
@Tag(name = "回调测试")
@RestController
@RequestMapping("/demo/callback")
@RequiredArgsConstructor
public class ClientNoticeReceiveController {
private final DaxPayDemoProperties daxPayDemoProperties;
@Operation(summary = "支付消息(map接收)")
@PostMapping("/pay")
public String pay(@RequestBody Map<String,Object> map){
log.info("接收到支付回调消息: {}",map);
// 转换为对象
PayNoticeModel bean = BeanUtil.toBean(map, PayNoticeModel.class);
log.info("验签结果: {}", PaySignUtil.hmacSha256Sign(bean, daxPayDemoProperties.getSignSecret()));
return "SUCCESS";
}
@Operation(summary = "支付消息(对象接收)")
@PostMapping("/payObject")
public String pay(@RequestBody PayNoticeModel model){
log.info("接收到支付回调消息: {}",model);
log.info("验签结果: {}", PaySignUtil.hmacSha256Sign(model, daxPayDemoProperties.getSignSecret()));
return "SUCCESS";
}
}
验签 ¶
java
// MD5方式验签
PaySignUtil.verifyMd5Sign(model, "123456", model.getSign());
// HmacSha256方式验签
PaySignUtil.verifyHmacSha256Sign(model, "123456", model.getSign());