notifyInvoice
入参
requestId String REQUIRED
由集成商定义的唯一请求 ID。
更多信息:
- 最大长度:32 字符
bizOrderId String
由万里汇定义的业务单 ID。
更多信息:
- 最大长度:32 字符
payToAmount Amount REQUIRED
支付金额,即集成商所创建账单的应付金额。
invoiceStatus String
单据状态。
可取值如下:
PROCESSING
:指用户在收银台提交支付且支付申请受理成功。FAILED
:指单渠道返回失败。SUCCESSFUL
:指渠道返回成功,但后续可能会出现退票场景。RETURNED
:指渠道返回退票。
errorCode String CONDITIONAL
错误码。
当 invoiceStatus 字段取值为
FAILED
时,此字段为必传。
更多信息:
- 最大长度:16 字符
errodMessage String CONDITIONAL
错误信息。
当 invoiceStatus 字段取值为
FAILED
时,此字段为必传。
更多信息:
- 最大长度:64 字符
extendInfo String
其他信息。
更多信息:
- 最大长度:128 字符
出参
result Result REQUIRED
代表API 接口的调用结果,即集成商是否成功接收通知。
API Explorer
请求
Case
When the invoice payment succeeds
请求体
响应
响应体
响应处理
在收到万里汇的请求之后,集成商需要向万里汇发送响应信息,以确认信息已收到。
发送响应信息前,集成商需正确加签。请参考以下示例。
详见:生成签名及加验签 及 API概览-响应报文结构 章节。
Sample Code
如果集成商不向万里汇发送响应信息,万里汇会重新发送请求通知。万里汇重发通知的规则为:
- 重试总数:7次
- 两次重发请求之间的间隔:2分钟,10分钟,10分钟,1小时,2小时,6小时,15小时
result.resultCode 结果码
结果码 | 值 | 结果码信息 | 行动建议 |
---|---|---|---|
SUCCESS | S | Success | |
UNKNOWN_EXCEPTION | U | API failed due to unknown reason. | 无需更换requestId,发起重试 |
PARAM_ILLEGAL | F | Illegal parameters exist. For example, a non-numeric input, or an invalid date. | 修改订单信息、更换requestId,发起重试 |
PROCESS_FAIL | F | A general business failure occurred. Do not retry. | 需要人工介入,联系万里汇技术支持以解决此问题 |
INVALID_API | F | The called API is invalid or not active. | 检查调用的接口是否正确 |
INVALID_CLIENT | F | The client is invalid. | 检查 Client ID 是否正确,发起重试 |
INVALID_SIGNATURE | F | The signature is invalid. | 检查用于加签的签名是否有效,发起重试 |
METHOD_NOT_SUPPORTED | F | The server does not implement the requested HTTP method. | 确保 HTTP 方式为 |