开发者可以调用该接口关闭已创建的订单。
例如用户在开发者应用中创建订单时,开发者的应用已同步在华为支付创建订单完成。用户需要取消订单重新创建,开发者在取消订单前可调用该接口关闭华为支付的订单,避免极端场景下用户重复支付。
承载协议 | HTTPS POST |
|---|---|
接口方向 | 开发者服务器-> 华为支付服务器 |
接口URL | https://petalpay-developer.cloud.huawei.com.cn/api/v1/aggr/transactions/orders/close |
数据格式 | 请求消息:Content-Type: application/json 响应消息:Content-Type: application/json |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
Content-Type | 是 | String | 取值为:application/json; charset=UTF-8 |
PayMercAuth | 是 | String | 取值为:PayMercAuth的JSON串 |
参数 | 是否必选 | 类型 | 说明 |
|---|---|---|---|
sysTransOrderNo | 否 | String | 华为支付系统订单号(与商户订单号二选一,如果两个都传,以系统订单号为准)。 |
mercOrderNo | 否 | String | 商户订单号,由商户自己生成,商户需保证订单信息唯一性。最大长度46。 |
POST /api/v1/aggr/transactions/orders/close HTTP/1.1
Content-Type: application/json;charset=UTF-8
PayMercAuth: {"callerId":"10132120***","traceId":"202305151026422776499","time":1684117602555,"authId":"120291744647139***","headerSign":"u+H1Oe3fXV9mGCES89XA7tSj********************DwKJH7rMv6SBj/z0UcN9QrxXSeR8r6X46b7491N1jKg/lOG7eAFfwjEWJu5JyvY5KunSeE6DiKs=","bodySign":"yWDtXOBqDoItPgHmF57L6U5G7F/LhsILChu8YSp********************imTcTN7pBpFA7pvFexUasPj10iUIFeaszpiRT2aQDaqLGaxvta6J5UxIUmAp+wGdV/juGEvQ="}
Accept: application/json
{
"mercOrderNo": "czl00120240705***"
} 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
Content-Type | 是 | String | 取值为:application/json; charset=UTF-8 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
resultCode | 是 | String | 返回码,"000000"表示成功,其他表示见错误码。 |
resultDesc | 是 | String | 结果描述。 |
subCode | 否 | String | 业务错误码。 |
subDesc | 否 | String | 业务错误描述信息。 |
sign | 是 | String | 签名值。用于开发者对响应报文进行防篡改验证。 |
HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
{
"resultCode": "000000",
"resultDesc": "Success.",
"sign": "MEQCIEIWzdpziRyTi8vhwWHFuDdxfsiwOGSr6********************er0YAMabeCgTDG77e+2XJItvq/ZkIcCN5/B20pQ=="
} (resultCode非400000的错误码请看公共错误码说明)
resultCode | resultDesc | subCode | subDesc |
400000 | 业务处理失败 | UNKNOW_ERROR | 服务暂不可用,请稍后重试 |
400000 | 业务处理失败 | INVALID_ARGUMENTS | 参数不合法 |
400000 | 业务处理失败 | INVALID_MERCNO | 无效商户号 |
400000 | 业务处理失败 | PAY_ORDER_NOT_EXIST | 支付订单号不存在 |
400000 | 业务处理失败 | MERC_ORDER_NOT_EXIST | 商户订单号不存在 |