订单查询接口

Endpoint
POST {BASE_URL}/api/v2.0/payments/inquiryPayment

订单查询接口,通过AlphaPay平台订单ID进行订单详情的查询。

Request Body
paymentIdstringREQUIRED

AlphaPay平台订单ID

订单查询Request Body
{
    "paymentId": "string"
}

Response (200 OK)
scenarioCodestring

场景代码,表示支付订单的使用场景,详情查看场景代码 (scenarioCode)
允许值:ONLINE_QRCODE ONLINE_WEB JSAPI NATIVE_JSAPI ONLINE_WAP APP MINI_APP CREDIT_CARD OFFLINE_QRCODE OFFLINE

paymentRequestIdstring

商户的订单ID

orderobject

订单信息

隐藏子字段
order.orderAmountobject

订单金额

隐藏子字段
order.orderAmount.valuestring

订单金额值,单位为货币最小单位,例如传入100表示1.00CAD,需符合正则: ^\d{1,7}$
currency如果是CNY,经汇率转换后不得低于0.01CAD,否则订单可以创建成功,但支付时会报金额不合法错误

order.orderAmount.currencystring

订单币种,允许值:CAD/USD CNY

order.descriptionstring

订单标题(最大长度128字符,超出自动截取)<= 128 characters

order.notifyUrlstring

支付通知URL,支付成功后推送支付成功通知的地址

order.redirectUrlstring

支付跳转URL,支付成功后会跳转到的地址

paymentCreateTimestring <date-time>

订单创建时间
遵循ISO8601标准,例如:2019-05-28T12:12:12+08:00

paymentExpireTimestring <date-time>

订单超时时间
遵循ISO8601标准,例如:2019-05-28T12:12:12+08:00

paymentTimestring <date-time>

订单支付时间
遵循ISO8601标准,例如:2019-05-28T12:12:12+08:00

paymentIdstring

AlphaPay平台订单ID

paymentStatusstring

订单状态,详情查看付款状态 (paymentStatus)

  • OFFLINE_QRCODE:等待支付
  • CLOSED:已关闭
  • FAILED:订单创建失败、支付失败
  • SUCCESS:支付成功
  • PARTIAL_REFUND:部分退款
  • FULL_REFUND:全额退款
resultobject

业务结果

隐藏子字段
result.resultCodestring

业务结果码,详情查看业务结果码 (resultCode)

result.resultMessagestring

业务结果消息

result.resultStatusstring

业务结果状态,详情查看业务结果状态 (resultStatus)

  • S:接口调用成功
  • F:接口调用失败,resultMessage会有详细的错误信息描述,可能是商户也可能是平台的错误。
  • U:业务结果未知或处理中间状态。比如提交支付单后得到 PAYMENT_IN_PROCESS,则需要调用查询接口确认支付结果状态
订单查询Response
{
    "scenarioCode": "APP",
    "paymentRequestId": "string",
    "order": {
        "orderAmount": {
            "value": "string",
            "currency": "CAD"
        },
        "description": "string",
        "notifyUrl": "string",
        "redirectUrl": "string"
    },
    "paymentCreateTime": "2019-08-24T14:15:22Z",
    "paymentExpireTime": "2019-08-24T14:15:22Z",
    "paymentTime": "2019-08-24T14:15:22Z",
    "paymentId": "string",
    "paymentStatus": "PAYMENT_IN_PROCESS",
    "result": {
        "resultCode": "string",
        "resultMessage": "string",
        "resultStatus": "S"
    }
}