订单还款通知

更新时间：2025.01.08

一笔交易订单发生垫资，用户还款后，由微信支付主动向商户发送订单还款通知。

注意

同样的通知可能会多次发送给商户系统。商户系统必须能够正确处理重复的通知。推荐的做法是，当商户系统收到通知进行处理时，先检查对应业务数据的状态，并判断该通知是否已经处理。如果未处理，则再进行处理；如果已处理，则直接返回结果成功。在对业务数据进行状态检查和处理之前，要采用数据锁进行并发控制，以避免函数重入造成的数据混乱。
如果在所有通知频率(1/60/60/60/60/60/60/60/60/60/60/300/300/300/300/300/300/300/300/300/300/（单位：秒）)后没有收到微信侧回调,商户应调用查询用户欠款状态接口确认欠款状态。

特别提醒：

商户系统对于确认订单通知的内容一定要做签名验证，并校验通知的信息是否与商户侧的信息一致，防止数据泄露导致出现“假通知”，造成资金损失。
当收到通知进行处理时，首先检查对应业务数据的状态，判断该通知是否已经处理过，如果没有处理过再进行处理，如果处理过直接返回结果成功。在对业务数据进行状态检查和处理之前，要采用数据锁进行并发控制，以避免函数重入造成的数据混乱。

接口说明

支持商户：【普通服务商】

请求方式：【POST】

回调URL：该链接需联系运营同学配置，必须为HTTPS协议。如果链接无法访问，商户将无法接收到微信通知。通知URL必须为直接可访问的URL，不能携带参数。示例: "http://pay.weixin.qq.com/wxpay/pay.action"

通知规则

还款后，微信后台会把相关确认结果和订单信息发送给商户，商户需要接收处理该消息，并返回应答。

对后台通知交互时，如果微信收到商户的应答不符合规范或超时，微信认为通知失败，微信会通过一定的策略定期重新发起通知，尽可能提高通知的成功率，但微信不保证通知最终能成功。（通知频率为：1/60/60/60/60/60/60/60/60/60/60/300/300/300/300/300/300/300/300/300/300/（单位：秒））

通知报文

还款结果通知是以POST 方法访问商户设置的通知URL，通知的数据以JSON 格式通过请求主体（BODY）传输。通知的数据包括了加密的支付结果详情。

注意

由于涉及到回调加密和解密，商户必须先设置好APIv3密钥后才能解密回调通知，APIv3密钥设置文档指引详见APIv3密钥设置指引

步骤说明

步骤一：验证签名

微信支付会对发送给商户的通知进行签名，并将签名值放在通知的HTTP头Wechatpay-Signature。商户应当验证签名，以确认请求来自微信，而不是其他的第三方。签名验证的算法请参考《微信支付API v3签名验证》。

步骤二：参数解密

为了保证安全性，微信支付在回调通知，对关键信息进行了AES-256-GCM加密。商户应当按照以下的流程进行解密关键信息，解密的流程：

用商户平台上设置的APIv3密钥【微信服务商平台—>账户设置—>API安全—>设置APIv3密钥】，记为key；
获取resource.algorithm中描述的算法（目前为AEAD_AES_256_GCM），以及resource.nonce和resource.associated_data；
使用key、nonce和associated_data，对数据密文resource.ciphertext进行解密，得到JSON形式的资源对象。

注意

AEAD_AES_256_GCM算法的接口细节，请参考rfc5116。微信支付使用的密钥key长度为32个字节，随机串nonce长度12个字节，associated_data长度小于16个字节并可能为空。
Java回调解密Json取值不带引号。

字段说明

通知参数

id 必填 string(32)

通知的唯一ID。

create_time 必填 string(32)

通知创建的时间，遵循rfc3339标准格式，格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE，yyyy-MM-DD表示年月日，T出现在字符串中，表示time元素的开头，HH:mm:ss表示时分秒，TIMEZONE表示时区（+08:00表示东八区时间，领先UTC 8小时，即北京时间）。例如：2015-05-20T13:29:35+08:00表示北京时间2015年05月20日13点29分35秒

event_type 必填 string(32)

通知的类型：

还款完成-通知类型：TRANSACTION.PAY_BACK

resource_type 必填 string(32)

通知的资源数据类型，确认成功通知为encryptresource。

resource 必填 object

通知资源数据。

属性

algorithm 必填 string(32)

对授权结果数据进行加密的加密算法，目前只支持AEAD_AES_256_GCM。

ciphertext 必填 string(1048576)

Base64编码后的授权/解除授权结果数据密文。

associated_data 选填 string(16)

附加数据。

nonce 必填 string(16)

加密使用的随机串。

还款结果通知

1{
2    "id":"EV-2018022511223320873",
3    "create_time":"2020-03-26T10:43:39+08:00",
4    "resource_type":"encrypt-resource",
5    "event_type":"TRANSACTION.PAY_BACK",
6    "resource" : {
7        "algorithm":"AEAD_AES_256_GCM",
8        "ciphertext": "...",
9        "nonce": "...",
10        "associated_data": ""
11    }
12}

resource解密后字段

mchid 必填 string(32)

微信支付分配的商户号。如果是服务商模式接入则为服务商商户号；如果是直连商户模式接入则为直连商户号。

appid 必填 string(32)

微信公众平台为服务商商户分配的公众账号ID，与商户号存在绑定关系。如果是服务商模式接入则为服务商商户号绑定的AppID；如果是直连商户模式接入则为直连商户号绑定的AppID。

sub_mchid 选填 string(32)

微信支付分配的商户号，服务商商户号与子商户号存在父子关系。如果是服务商模式接入则有值；如果是直连商户模式接入则该字段为空。

sub_appid 选填 string(32)

微信公众平台为商户分配的公众账号ID，与子商户号存在绑定关系。如果是服务商模式接入则有值；如果是直连商户模式接入则该字段为空。

out_trade_no 必填 string(64)

商户自行生成的订单号，要求64个字符内，只能是数字、大小写字母和_-，且在同一个商户号下唯一。

transaction_id 选填 string(32)

微信支付订单号，订单已受理，但未完成扣款时不返回。

trade_type 选填 string(32)

交易类型，订单已受理，但未完成扣款时不返回，取值如下：
AUTH：平台代扣

trade_state 必填 string(32)

本支付订单的状态，可选枚举值：
SUCCESS：支付成功;
REFUND：转入退款;
ACCEPTED：已受理，未支付;
PAY_FAIL：支付失败(其他原因，如银行返回失败);
PAY_BACK：还款

trade_state_desc 选填 string(256)

对当前订单状态的描述和下一步操作的指引。

bank_type 选填 string(32)

银行类型，扣款成功时返回，采用字符串类型的银行标识，值列表详见银行类型。
注：使用BPA表示本笔订单由微信支付预先垫付资金。

attach 选填 string(127)

附加数据，在查询API和支付通知中原样返回，该字段主要用于商户携带订单的自定义数据

success_time 选填 string(32)

支付订单已成功才会返回，遵循rfc3339标准格式，格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE，yyyy-MM-DD表示年月日，T出现在字符串中，表示time元素的开头，HH:mm:ss表示时分秒，TIMEZONE表示时区（+08:00表示东八区时间，领先UTC 8小时，即北京时间）。例如：2015-05-20T13:29:35+08:00表示北京时间2015年05月20日13点29分35秒。

payer 选填 object

支付者

属性

openid 必填 string(128)

用户在商户AppID下的唯一标识。

amount 必填 object

订单金额信息

属性

total 必填 int

订单总金额，单位为分，只能为整数。

payer_total 选填 int

用户实际支付金额，支付成功时有返回，单位为分，只能为整数。

discount_total 选填 int

订单折扣，有优惠折扣则返回该字段。

currency 必填 string(3)

符合ISO 4217标准的三位字母代码，目前只支持人民币：CNY。

device_info 必填 object

设备信息

属性

device_id 选填 string(32)

商户设备号，商户自定义，最大长度32个字符。

promotion_detail 选填 array

优惠详情

数组

coupon_id 选填 string(32)

券ID。

name 选填 string(64)

优惠名称。

scope 选填 string(32)

枚举值：
GLOBAL：全场代金券
SINGLE：单品优惠

type 选填 string(32)

COUPON：代金券，需要走结算资金的充值型代金券（境外商户券币种与支付币种一致）
DISCOUNT：优惠券，不走结算资金的免充值型优惠券（境外商户券币种与标价币种一致）

amount 选填 int

优惠券面额。

stock_id 选填 string(32)

活动ID，批次ID。

wechatpay_contribute 选填 int

特指由微信支付商户平台创建的优惠，出资金额等于本项优惠总金额，单位为分。

merchant_contribute 选填 int

特指商户自己创建的优惠，出资金额等于本项优惠总金额，单位为分。

other_contribute 选填 int

其他出资方出资金额，单位为分。

对resource对象进行解密后，得到的资源对象示例

1{
2  "mchid": "1230000109",
3  "appid": "wx8888888888888888",
4  "sub_mchid": "1900000109",
5  "sub_appid": "wx8888888888888888",
6  "out_trade_no": "201407033233368018",
7  "transaction_id": "25012014070332333018",
8  "trade_type": "AUTH",
9  "trade_state": "SUCCESS",
10  "trade_state_desc": "支付成功",
11  "bank_type": "ICBC_DEBIT",
12  "attach": "自定义数据",
13  "success_time": "2020-03-26T10:43:39+08:00",
14  "payer": {
15    "openid": "oUpF8uMuAJOM2pxb1Q",
16    "sub_openid": "oUpF8uMuAJOM2pxb1Q"
17  },
18  "amount": {
19    "total": 888,
20    "payer_total": 888,
21    "discount_total": 100,
22    "currency": "CNY"
23  },
24  "device_info": {
25    "device_id": "12343232",
26    "device_ip": "123.12.12.123"
27  },
28  "promotion_detail": [
29    {
30      "coupon_id": "109519",
31      "name":"单品惠-6",
32      "scope":"GLOBALSINGLE",
33      "type":"DISCOUNTCOUPON",
34      "amount": 5,
35      "stock_id": "931386",
36      "wechatpay_contribute":100,
37      "merchant_contribute":100,
38      "other_contribute":100
39    }
40  ]
41}

通知应答

接收成功： HTTP应答状态码需返回200或204，无需返回应答报文。

接收失败： HTTP应答状态码需返回5XX或4XX，同时需返回应答报文，格式如下：

code 必填 string(32)

错误码，SUCCESS为清算机构接收成功，其他错误码为失败。

message 必填 string(64)

返回信息，如非空，为错误原因。

应答示例

1{
2 "code": "SUCCESS",
3  "message": "成功"
4}

文档是否有帮助

更多支持

开发文档(商户)开发文档(V2版)开发者社区微信开放平台微信公众平台腾讯客服