Cancel a PENDING order (customer-initiated abort)

POST

/rest/v1/checkout/cancel-payment/{orderId}

Authorizations

bearerAuth

JWT access token obtained from /rest/auth/admin/login or /rest/auth/customer/login

Type

HTTP (bearer)

Parameters

Path Parameters

orderId*

Type

integer

Required

Responses

Payment cancellation result

POST

/rest/v1/checkout/cancel-payment/{orderId}

Playground

Authorization

bearerAuth

Variables

Key

Value

orderId*

Samples

Powered by VitePress OpenAPI