When the payment order is created but not yet paid, the merchant can use the payment ID or merchant order number to cancel it.

Request

Request payload

POST /payment/api/v1/payment-order/cancel HTTP/1.1
Content-Type: application/json

{
    "merchantId": "string",
    "method": "string",
    "format": "string",
    "charset": "string",
    "encryptType": "string",
    "signType": "string",
    "sign": "string",
    "timestamp": "Number",
    "body": "&lt;encrypted body string&gt;" // the encrypted body string
    
    // the body data structure
    // { 
    //     "paymentId": "string"
    // }
}

Please follow the Request Payload to construct the request payload.

Set the method parameter to bieases.trade.cancel.
Set to body parameter to Body object.

Body object

The parameters of body object in the Request Payload.

Key	Type	Mandatory?	Length	Description	Example
paymentId	String	Yes	32	The payment order number regarding the payment request	01J143NWJFNGBV2YB9ZRB9T7PS

Response

Response payload

200 OK
Content-Type: "application/json"

{
    "code": "string",
    "msg": "string",
    "data": 
    {
       "paymentId":"string",
       "referOrderNo":"string",
       "status":"string"
    }
}

The request will return an HTTP status code 200 if successful, with details included in the Data object of the response payload.

Data object defined as below

📘
Note
The response is returned synchronously and does not require signature verification and decryption.

Data object

Key	Type	Description	Example
paymentId	String	The payment order number regarding the payment request	01J143NWJFNGBV2YB9ZRB9T7PS
referOrderNo	String	The order number on the merchant's platform	2013112111001004500000675971
status	String	The order cancel operation status.