Cancel Reservation
DELETE/client/users/:correlation_id/reservations/:reservation_token
Removes the reservation hold for the given reservation token, if the token has not already been consumed and belongs to the account identified by the session (referenced by the correlation id).
Request
Body
This Request does not have a Body.
Response
| Attribute | Definition | Format | Notes |
|---|---|---|---|
| status | Identifies the status of the redemption reservation to be invoked. | String | Value is always "CANCELLED" except for Error states |
| reservationToken | Identifies the token used to reserve the redemption. | String | |
| sessionId | Used to identify the account session during which the redemption reservation is being cancelled. | String |
Error Responses
| statusCode | errorMessage | errorCode | Definition |
|---|---|---|---|
| 400 Bad Request | Adhoc Redemption feature is not enabled | INVALID_REQUEST | Adhoc Redemption feature is not enabled |
| 400 Bad Request | Session Closed | INVALID_REQUEST | Session has been closed, so response cannot be provided |
| 400 Bad Request | Session correlation ID does not exist--create it first | INVALID_REQUEST | Create a session correlation_id before making this request |
Request
Responses
- 200
- 400
200 - Cancel Reservation
400 - Session Closed