WorldFirst DocsWorldFirst DocsDOCS

queryInvoice

POST: /amsin/api/v1/business/fund/queryInvoice

需要签名验签

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

接口结构

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

请求参数

字段名

数据类型

是否必填

描述

requestId

字符串

是

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

更多信息：

  • 字段最大长度：32

响应参数

字段名

数据类型

是否必填

描述

requestId

字符串

是

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

更多信息：

  • 字段最大长度：32
bizOrderId

字符串

否

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

更多信息：

  • 字段最大长度：32

payToAmount

Amount 对象

是

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

invoiceStatus

字符串

否

单据状态。可取值如下：

  • INIT：指用户在收银台未发起支付。
  • PROCESSING：指用户在收银台提交支付且支付申请受理成功。
  • FAILED：指单渠道返回失败。
  • SUCCESSFUL：指渠道返回成功，但后续可能会出现退票场景。
  • RETURNED：指渠道返回退票。

result

Result 对象

是

API 调用结果，即集成商是否成功接收通知。

结果码

resultCode

resultStatus

resultMessage

resultMessage

中文含义

SUCCESS

S

Success

成功

UNKNOWN_EXCEPTION

U

API failed due to unknown reason.

未知错误

PARAM_ILLEGAL

F

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

存在非法参数，例如输入非数字值或无效日起。

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.

调用的用户无效

INVALID_SIGNATURE

F

The signature is invalid.

签名无效

METHOD_NOT_SUPPORTED

F

The server does not implement the requested HTTP method.

服务器无法执行发起请求的 HTTP 方式

UN_SUPPORT_BUSINESS

F

Unsupported business.

使用正确的参数重试

代码示例

请求体

copy
{

    "requestId": "1664551447974129669"

}

响应体

copy
{
    "bizOrderId": "2023060519154000000783300468191",
    "invoiceStatus": "RETURNED",
    "payToAmount": {
        "currency": "GBP",
        "value": "100"
    },
    "requestId": "1664551447974129669",
    "result": {
        "resultStatus": "S",
        "resultCode": "SUCCESS",
        "resultMessage": "success"
    }
}

@2024 WorldFirst