Invalidate an order
POST/orders/:id/actions/invalidate
Invalidate an order due to technical issues or if the client is unsure whether the transaction succeeded.
Invalidation is only possible once an order reached the completed state. While still in processing state, the order might be partially processed and no clean invalidation can be guaranteed. Invalidation is only allowed for a limited amount of time and should be executed as soon as possible after the order was created.
Once an order was invalidated, it cannot be used anymore.
Responses
- 200
- 404
- 500
Order details with the updated state
Not Found
Internal Server Error
Error Codes
| HTTP Status | Class | Code | Description |
|---|---|---|---|
| 404 | not_found | entity_not_found | Entity not found |
| 400 | invalid_state | order_processing | The order is still processing and cannot be invalidated |
| 400 | invalid_state | order_invalidated | The order has already been invalidated |
| 400 | invalid_state | order_failed | The order already failed |
| 400 | invalid_state | order_invalidation_period_expired | The order invalidation period has expired |
| 400 | invalid_state | order_invalidation_not_supported | The order cannot be invalidated |