WorldFirst DocsWorldFirst DocsDOCS

inquirePayment

POST: /amsin/api/v1/business/inquiryPayOrder

需要签名验签

支付完成后，集成商可以使用此接口来查询支付结果。

接口结构

万里汇接口报文结构包括：请求头，请求体。关于头信息，详见：

请求参数

字段名

数据类型

是否为必填字段

描述

payToRequestIds

列表<字符串>

是（有条件）

集成商查询的payToRequestId 列表。

payToRequestId，由商户生成的支付请求号，可以唯一标识每笔支付。

更多信息：

  • PayToRequestIds 和 payToIds 字段不能同时为空
  • 字段最大长度：64

payToIds

列表<字符串>

是（有条件）

集成商查询的payToId 列表。

payToId，由万里汇生成的支付单号，可以唯一标识每笔支付。

更多信息：

  • PayToRequestIds 和 payToIds 字段不能同时为空
  • 字段最大长度：64

响应参数

字段名

数据类型

是否为必填字段

描述

result

Result 对象

是

本次调用结果, 反映本次调用的业务状态、错误信息等（不表示支付受理结果）

payToSummaries

数组<PayToSummary 对象>

是

订单维度总结信息

paymentDetailSummaries

数组<PaymentDetailSummary 对象>

是

支付详情

(标准收银台模式下，如果没有支付，则没有支付信息)

feeDetailSummaries

数组<FeeDetailSummary 对象>

是

费用详情

响应处理

createCashierPayment支付为异步通知，集成商调用此接口后，万里汇响应该订单的受理状态。集成商需调用inquirePayment接口来查询订单的支付状态（即查询支付是否成功）。

  • 如支付成功：则继续进行其他操作。
  • 如支付处理中：可再次调用inquirePayment接口来查询订单状态，或者等待notifyPayment发送结果通知。
  • 如支付结果不成功，集成商需要再次调用createCashierPayment接口再次发送支付请求。发送支付请求时，集成商需要传输不同的payToRequestId字段。

集成商发送请求后，万里汇响应两个状态码：

  • result.resultStatus：展示API请求结果
  • payToSummaries.orderResult.status：展示支付订单的结果

result.resultStatus的取值范围为：

resultStatus

状态描述

S

API请求成功

F

API请求失败

失败原因请检查结果码(即result.resultCode和reult.resultMessage)

U

API检查结果未知，请重试API请求。

重试策略：

  • 重试最多次数：7次
  • 重试间隔：5m, 10m, 20m, 40m, 80m, 160m, and 320m

如果问题继续，请联系万里汇技术支持

payToSummaries.orderResult.status的取值范围为：

payToSummaries.orderResult.status

状态描述

WAIT_PAY

订单处理中

PAY_SUCCESS

支付成功

PAY_FAILED

支付失败

PAY_CANCELLED

支付已取消

结果码

resultCode

resultStatus

resultMessage

处理建议

SUCCESS

S

Success

PROCESSING

S

The payment is being processed.

支付处理中，请等待支付结果通知或调用inquirePayment接口查询支付结果

PROCESS_FAIL

F

A general business failure occurred. Do not retry.

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

PARAM_ILLEGAL

F

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

参考API文档页面以确认请求头和传参是否正确

UNKNOWN_EXCEPTION

U

The API call is failed, which is caused by unknown reasons.

服务器忙。若稍后重试问题依旧，联系万里汇技术支持以解决问题

范例

请求

copy
{
    "payToRequestIds":["*****"]
}

响应

copy
{
    "feeDetailSummaries": [
        {
            "feeAmount": {
                "currency": "USD",
                "value": "3"
            },
            "paymentMethodType": "WALLET_WF"
        }
    ],
    "payToSummaries": [
        {
            "orderResult": {
                "status": "PAY_SUCCESS"
            },
            "payToAmount": {
                "currency": "USD",
                "value": "1000"
            },
            "payToCreateTime": "2022-06-17T01:43:58-07:00",
            "payToId": "*****",
            "payToRequestId": "requestId_*****"
        }
    ],
    "paymentDetailSummaries": [
        {
            "paymentAmount": {
                "currency": "USD",
                "value": "1000"
            },
            "paymentMethodMetaData": "{}",
            "paymentMethodType": "WALLET_WF"
        }
    ],
    "result": {
        "resultCode": "SUCCESS",
        "resultMessage": "success.",
        "resultStatus": "S"
    }
}

@2024 WorldFirst