取消订单接口

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

取消订单接口，根据AlphaPay平台订单ID取消订单。

Request Body
paymentIdstringREQUIRED

AlphaPay平台订单ID

取消订单Request Body
{
    "paymentId": "string"
}
Response (200 OK)
paymentRequestIdstring

商户的订单ID

paymentIdstring

AlphaPay平台订单ID

cancelTimestring <date-time>

订单取消时间
遵循ISO8601标准，例如：2019-05-28T12:12:12+08:00

resultobject

业务结果

隐藏子字段
result.resultCodestring

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

result.resultMessagestring

业务结果消息

result.resultStatusstring

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

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