v1

latestOpenAPI 3.0.12026-07-24128351404.9 KB
Payments

Cancel a payment order

Cancel an existing payment order. This interface can be called to cancel the payment for non-card payment scenarios or other cases when the payment is not completed. After cancellation is completed, the status will change to canceled, and the original payment link (including checkout page and iframe mode) will become invalid and cannot be used for payment anymore.

post/open-api/v3/acquiring/payments/cancel

Request body

merchantTradeNostring required

Merchant trade number to be cancelled, globally unique/idempotent

reasonstring

Cancellation reason

Example request

{
  "merchantTradeNo": "d7f9c511-9b7c-4a4c-a3eb-59a28b414d63",
  "reason": "Customer request"
}

Response

OK

codeinteger

Return code

messagestring

Error message