Cancel an order

POST /v3/session/:sessionId/order/cancel

Cancel an order of a payment session. It is only possible to cancel an order that has order status order_approved_not_captured. If the order has been captured it is no longer possible to cancel the order as it should be refunded instead. It is also not possible to cancel a pending or rejected order.

Path Parameters

• sessionId string required

  Format: UUID

  Example: c5674f4f-7e84-405c-a44b-c83736bb7209

Header Parameters

• Content-Type string

  Possible values: [application/json]

• Accept string

  Possible values: [application/json]

• Authorization string

  Format: "Basic <base64(username:secret)>"

Responses

• 204
• 400
• 403

---

application/json

Schema

Schema

• error object

  code string

  Possible values: [INVALID_CREDENTIALS, CANCEL_NOT_SUPPORTED, INVALID_DATA, ORDER_NOT_COMPLETED, ORDER_REJECTED, ORDER_PENDING, ORDER_ALREADY_CAPTURED, ORDER_ALREADY_CANCELLED, UNKNOWN]

  message string

Example (from schema)

{
  "error": {
    "code": "INVALID_CREDENTIALS",
    "message": "string"
  }
}

application/json

Schema

Schema

• error object

  code string

  Possible values: [INVALID_CREDENTIALS, INVALID_API_KEY, AUTH_SECRET_EXPIRED]

  message string

Example (from schema)

{
  "error": {
    "code": "INVALID_CREDENTIALS",
    "message": "string"
  }
}

Loading...