Skip to content

Quote cancellation

GET
/api/booking/{bookingIdentifier}/refund-preview
curl --request GET \
--url https://api.wink.travel/api/booking/f4d1c8e5-2b9a-4f3d-9e7c-1b6a5d3f8c92/refund-preview \
--header 'Authorization: Bearer <token>' \
--header 'Wink-Version: 2.0'

Read-only preview of the refund and cancellation policy for cancelling a single booking, so the traveler is informed before confirming. Nothing is cancelled.

bookingIdentifier
required
string
""

Quote cancellation for this booking identifier

Example
f4d1c8e5-2b9a-4f3d-9e7c-1b6a5d3f8c92
Wink-Version
string
default: 2.0.0
Allowed values: 2.0

Single booking cancellation refund preview

Media type application/json

Read-only preview of what cancelling a single booking would refund, shown to the traveler before confirming cancellation.

object
bookingIdentifier

The booking’s internal identifier.

string format: uuid
""
bookingCode

The human-readable booking code.

string
""
hotelName

The property name for this booking.

string
""
startDate

Check-in date.

string format: date
""
endDate

Check-out date.

string format: date
""
displayCurrency

The traveler’s display currency code.

string
"" /^[A-Z]{3}$/
refundable

Whether this booking refunds any money when cancelled.

boolean
refundDisplayAmount

Refund amount in the traveler’s display currency (0 when non-refundable).

number
""
refundType

Whether the refund is FULL, PARTIAL, or NONE.

string
""
Allowed values: NONE PARTIAL FULL
cancellationPolicy

Human-readable cancellation policy text (may be long).

string
""
key
additional properties
""
Example
{
"bookingIdentifier": "f4d1c8e5-2b9a-4f3d-9e7c-1b6a5d3f8c92",
"bookingCode": "MAVWBWMD",
"hotelName": "The Siam Residences, Bangkok",
"startDate": "2026-06-09",
"endDate": "2026-06-12",
"displayCurrency": "USD",
"refundable": true,
"refundDisplayAmount": 120,
"refundType": "FULL",
"cancellationPolicy": "Free cancellation until 24 hours before check-in. After that, the first night is charged."
}

Bad Request — missing or invalid request parameter or body

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

Unauthorized — authentication is required or the session has expired

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

Forbidden — authenticated but lacking the required permission or scope

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

Not Found — the requested resource does not exist

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

Method Not Allowed — the HTTP verb is not supported on this endpoint

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

Unsupported Media Type — use application/json

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

Internal Server Error — an unexpected failure occurred on the server

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

Service Unavailable — a downstream dependency is unreachable

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example