notifyInvoice

万里汇使用此接口向集成商返回单据支付结果。

报文结构

万里汇接口的报文结构包括:请求头、请求体、响应头和响应体。该章节主要介绍请求体和响应体的结构。关于请求头和响应头的更多信息,参见:

入参

requestId String  REQUIRED

由集成商定义的唯一请求 ID。

更多信息:

  • 最大长度:32 字符

bizOrderId String  

由万里汇定义的业务单 ID。

更多信息:

  • 最大长度:32 字符

payToAmount Amount  REQUIRED

支付金额,即集成商所创建账单的应付金额。

Show child parameters

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 接口的调用结果,即集成商是否成功接收通知。

Show child parameters
API Explorer

请求

Case
When the invoice payment succeeds
请求体

响应

响应体

结果码

结果码结果码信息行动建议
SUCCESSSSuccess
UNKNOWN_EXCEPTIONUAPI failed due to unknown reason.

无需更换requestId,发起重试

PARAM_ILLEGALFIllegal parameters exist. For example, a non-numeric input, or an invalid date.

修改订单信息、更换requestId,发起重试

PROCESS_FAILFA general business failure occurred. Do not retry.

需要人工介入,联系万里汇技术支持以解决此问题

INVALID_APIFThe called API is invalid or not active.

检查调用的接口是否正确

INVALID_CLIENTFThe client is invalid.

检查 Client ID 是否正确,发起重试

INVALID_SIGNATUREFThe signature is invalid.

检查用于加签的签名是否有效,发起重试

METHOD_NOT_SUPPORTEDFThe server does not implement the requested HTTP method.

确保 HTTP 方式为 POST,发起重试

@2024 WorldFirst