Help Center > > API Reference> Transaction Management> Managing Yearly/Monthly Orders> Canceling Orders in the Pending Payment Status

Canceling Orders in the Pending Payment Status

Updated at: Jun 17, 2021 GMT+08:00

Function

A customer can invoke this API to cancel orders in the pending payment status.

Customers can follow the instructions described in Cancellation to cancel yearly/monthly product orders in the pending payment status in Billing Center.

Only the orders in the pending payment status can be canceled.

Constraints

This API can be invoked using the customer AK/SK or token only.

URI

PUT /v2/orders/customer-orders/cancel

Request

Request Parameters

Parameter

Mandatory

Type

Value Range

Description

order_id

Yes

String

A maximum of 64 characters

Order ID.

The value is the same as the value of order_id in the response of the API described in Querying Orders.

Example Request

PUT https://bss-intl.myhuaweicloud.com/v2/orders/customer-orders/cancel HTTP/1.1
Content-Type: application/json
X-Auth-Token: MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ
{
  "order_id": "CS170926155954NO7"
}

Response

Response Parameters

Table 1 Response parameters

Parameter

Type

Value Range

Description

error_code

String

A maximum of 10 characters

Status code.

For details, see Returned Values.

error_msg

String

A maximum of 256 characters

Error description.

Example Response

HTTP/1.1 204 No Content
Content-Type: application/json;charset=UTF-8
Content-Length: length
Date: response time 

Returned Values

HTTP Value

Error Code

Description

400

CBC.0100

Parameter error.

400

CBC.99005010

Orders in this state cannot be canceled.

403

CBC.0151

Access denied.

500

CBC.0999

Other errors.

Did you find this page helpful?

Submit successfully!

Thank you for your feedback. Your feedback helps make our documentation better.

Failed to submit the feedback. Please try again later.

Which of the following issues have you encountered?







Please complete at least one feedback item.

Content most length 200 character

Content is empty.

OK Cancel